From 7fe405b8b7032d1ab9c429e867beeb8e021bfad0 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 7 Mar 2024 16:24:27 +1100 Subject: [PATCH] added awscc --- .github/workflows/build-docs.yaml | 2 +- README.md | 1 + ci-scripts/get-providers-to-deploy.js | 1 + docs/awscc-docs/index.md | 302 ++++++++++++++++++ .../awscc/accessanalyzer/analyzer/index.md | 80 +++++ .../awscc/accessanalyzer/analyzers/index.md | 62 ++++ .../providers/awscc/accessanalyzer/index.md | 39 +++ .../awscc/acmpca/certificate/index.md | 80 +++++ .../acmpca/certificate_authorities/index.md | 63 ++++ .../acmpca/certificate_authority/index.md | 89 ++++++ .../certificate_authority_activation/index.md | 73 +++++ .../index.md | 55 ++++ .../awscc/acmpca/certificates/index.md | 57 ++++ .../providers/awscc/acmpca/index.md | 45 +++ .../awscc/acmpca/permission/index.md | 66 ++++ .../awscc/acmpca/permissions/index.md | 57 ++++ .../providers/awscc/amplify/app/index.md | 120 +++++++ .../providers/awscc/amplify/apps/index.md | 69 ++++ .../providers/awscc/amplify/branch/index.md | 117 +++++++ .../providers/awscc/amplify/branches/index.md | 73 +++++ .../providers/awscc/amplify/domain/index.md | 98 ++++++ .../providers/awscc/amplify/domains/index.md | 64 ++++ .../providers/awscc/amplify/index.md | 43 +++ .../awscc/amplifyuibuilder/component/index.md | 105 ++++++ .../amplifyuibuilder/components/index.md | 66 ++++ .../awscc/amplifyuibuilder/form/index.md | 98 ++++++ .../awscc/amplifyuibuilder/forms/index.md | 67 ++++ .../providers/awscc/amplifyuibuilder/index.md | 43 +++ .../awscc/amplifyuibuilder/theme/index.md | 88 +++++ .../awscc/amplifyuibuilder/themes/index.md | 66 ++++ .../awscc/apigateway/account/index.md | 67 ++++ .../awscc/apigateway/accounts/index.md | 56 ++++ .../awscc/apigateway/api_key/index.md | 83 +++++ .../awscc/apigateway/api_keys/index.md | 60 ++++ .../awscc/apigateway/authorizer/index.md | 86 +++++ .../awscc/apigateway/authorizers/index.md | 61 ++++ .../apigateway/base_path_mapping/index.md | 72 +++++ .../apigateway/base_path_mappings/index.md | 61 ++++ .../apigateway/client_certificate/index.md | 70 ++++ .../apigateway/client_certificates/index.md | 60 ++++ .../awscc/apigateway/deployment/index.md | 78 +++++ .../awscc/apigateway/deployments/index.md | 63 ++++ .../apigateway/documentation_part/index.md | 71 ++++ .../apigateway/documentation_parts/index.md | 61 ++++ .../apigateway/documentation_version/index.md | 69 ++++ .../documentation_versions/index.md | 61 ++++ .../awscc/apigateway/domain_name/index.md | 85 +++++ .../awscc/apigateway/domain_names/index.md | 58 ++++ .../apigateway/gateway_response/index.md | 71 ++++ .../apigateway/gateway_responses/index.md | 59 ++++ .../providers/awscc/apigateway/index.md | 75 +++++ .../awscc/apigateway/method/index.md | 92 ++++++ .../awscc/apigateway/methods/index.md | 60 ++++ .../providers/awscc/apigateway/model/index.md | 74 +++++ .../awscc/apigateway/models/index.md | 61 ++++ .../apigateway/request_validator/index.md | 73 +++++ .../apigateway/request_validators/index.md | 61 ++++ .../awscc/apigateway/resource/index.md | 71 ++++ .../awscc/apigateway/resources/index.md | 60 ++++ .../awscc/apigateway/rest_api/index.md | 101 ++++++ .../awscc/apigateway/rest_apis/index.md | 64 ++++ .../providers/awscc/apigateway/stage/index.md | 93 ++++++ .../awscc/apigateway/stages/index.md | 63 ++++ .../awscc/apigateway/usage_plan/index.md | 80 +++++ .../awscc/apigateway/usage_plan_key/index.md | 66 ++++ .../awscc/apigateway/usage_plan_keys/index.md | 59 ++++ .../awscc/apigateway/usage_plans/index.md | 60 ++++ .../awscc/apigateway/vpc_link/index.md | 87 +++++ .../awscc/apigateway/vpc_links/index.md | 68 ++++ .../providers/awscc/apigatewayv2/api/index.md | 106 ++++++ .../awscc/apigatewayv2/api_mapping/index.md | 74 +++++ .../awscc/apigatewayv2/api_mappings/index.md | 60 ++++ .../awscc/apigatewayv2/apis/index.md | 61 ++++ .../awscc/apigatewayv2/authorizer/index.md | 90 ++++++ .../awscc/apigatewayv2/authorizers/index.md | 61 ++++ .../awscc/apigatewayv2/deployment/index.md | 73 +++++ .../awscc/apigatewayv2/deployments/index.md | 60 ++++ .../awscc/apigatewayv2/domain_name/index.md | 76 +++++ .../awscc/apigatewayv2/domain_names/index.md | 60 ++++ .../providers/awscc/apigatewayv2/index.md | 57 ++++ .../integration_response/index.md | 82 +++++ .../integration_responses/index.md | 62 ++++ .../awscc/apigatewayv2/model/index.md | 77 +++++ .../awscc/apigatewayv2/models/index.md | 60 ++++ .../awscc/apigatewayv2/route/index.md | 91 ++++++ .../apigatewayv2/route_response/index.md | 80 +++++ .../apigatewayv2/route_responses/index.md | 62 ++++ .../awscc/apigatewayv2/routes/index.md | 60 ++++ .../awscc/apigatewayv2/vpc_link/index.md | 84 +++++ .../awscc/apigatewayv2/vpc_links/index.md | 66 ++++ .../awscc/appconfig/application/index.md | 73 +++++ .../awscc/appconfig/applications/index.md | 61 ++++ .../appconfig/configuration_profile/index.md | 88 +++++ .../appconfig/configuration_profiles/index.md | 64 ++++ .../awscc/appconfig/environment/index.md | 79 +++++ .../awscc/appconfig/environments/index.md | 64 ++++ .../awscc/appconfig/extension/index.md | 82 +++++ .../appconfig/extension_association/index.md | 82 +++++ .../appconfig/extension_associations/index.md | 59 ++++ .../awscc/appconfig/extensions/index.md | 60 ++++ .../hosted_configuration_version/index.md | 75 +++++ .../hosted_configuration_versions/index.md | 62 ++++ .../providers/awscc/appconfig/index.md | 49 +++ .../awscc/appflow/connector/index.md | 72 +++++ .../awscc/appflow/connector_profile/index.md | 86 +++++ .../awscc/appflow/connector_profiles/index.md | 67 ++++ .../awscc/appflow/connectors/index.md | 59 ++++ .../providers/awscc/appflow/flow/index.md | 97 ++++++ .../providers/awscc/appflow/flows/index.md | 73 +++++ .../providers/awscc/appflow/index.md | 43 +++ .../appintegrations/data_integration/index.md | 108 +++++++ .../data_integrations/index.md | 74 +++++ .../event_integration/index.md | 77 +++++ .../event_integrations/index.md | 59 ++++ .../providers/awscc/appintegrations/index.md | 41 +++ .../awscc/applicationautoscaling/index.md | 41 +++ .../scalable_target/index.md | 92 ++++++ .../scalable_targets/index.md | 73 +++++ .../scaling_policies/index.md | 61 ++++ .../scaling_policy/index.md | 82 +++++ .../applicationinsights/application/index.md | 83 +++++ .../applicationinsights/applications/index.md | 58 ++++ .../awscc/applicationinsights/index.md | 39 +++ .../auto_scaling_configuration/index.md | 73 +++++ .../auto_scaling_configurations/index.md | 60 ++++ .../providers/awscc/apprunner/index.md | 47 +++ .../observability_configuration/index.md | 69 ++++ .../observability_configurations/index.md | 60 ++++ .../awscc/apprunner/service/index.md | 88 +++++ .../awscc/apprunner/services/index.md | 69 ++++ .../awscc/apprunner/vpc_connector/index.md | 69 ++++ .../awscc/apprunner/vpc_connectors/index.md | 63 ++++ .../apprunner/vpc_ingress_connection/index.md | 75 +++++ .../vpc_ingress_connections/index.md | 63 ++++ .../awscc/appstream/app_block/index.md | 77 +++++ .../appstream/app_block_builder/index.md | 100 ++++++ .../appstream/app_block_builders/index.md | 64 ++++ .../awscc/appstream/app_blocks/index.md | 58 ++++ .../awscc/appstream/application/index.md | 90 ++++++ .../index.md | 66 ++++ .../index.md | 59 ++++ .../application_fleet_association/index.md | 63 ++++ .../application_fleet_associations/index.md | 57 ++++ .../awscc/appstream/applications/index.md | 56 ++++ .../awscc/appstream/directory_config/index.md | 87 +++++ .../appstream/directory_configs/index.md | 70 ++++ .../awscc/appstream/entitlement/index.md | 76 +++++ .../awscc/appstream/entitlements/index.md | 56 ++++ .../awscc/appstream/image_builder/index.md | 103 ++++++ .../awscc/appstream/image_builders/index.md | 76 +++++ .../providers/awscc/appstream/index.md | 53 +++ .../awscc/appsync/domain_name/index.md | 72 +++++ .../domain_name_api_association/index.md | 69 ++++ .../domain_name_api_associations/index.md | 55 ++++ .../awscc/appsync/domain_names/index.md | 61 ++++ .../appsync/function_configuration/index.md | 94 ++++++ .../appsync/function_configurations/index.md | 59 ++++ .../providers/awscc/appsync/index.md | 47 +++ .../providers/awscc/appsync/resolver/index.md | 98 ++++++ .../awscc/appsync/resolvers/index.md | 60 ++++ .../appsync/source_api_association/index.md | 93 ++++++ .../appsync/source_api_associations/index.md | 60 ++++ docs/awscc-docs/providers/awscc/aps/index.md | 41 +++ .../awscc/aps/rule_groups_namespace/index.md | 77 +++++ .../awscc/aps/rule_groups_namespaces/index.md | 61 ++++ .../providers/awscc/aps/workspace/index.md | 101 ++++++ .../providers/awscc/aps/workspaces/index.md | 71 ++++ .../providers/awscc/arczonalshift/index.md | 39 +++ .../zonal_autoshift_configuration/index.md | 72 +++++ .../zonal_autoshift_configurations/index.md | 62 ++++ .../athena/capacity_reservation/index.md | 87 +++++ .../athena/capacity_reservations/index.md | 62 ++++ .../awscc/athena/data_catalog/index.md | 76 +++++ .../awscc/athena/data_catalogs/index.md | 59 ++++ .../providers/awscc/athena/index.md | 47 +++ .../awscc/athena/named_queries/index.md | 58 ++++ .../awscc/athena/named_query/index.md | 69 ++++ .../awscc/athena/prepared_statement/index.md | 71 ++++ .../awscc/athena/prepared_statements/index.md | 61 ++++ .../awscc/athena/work_group/index.md | 92 ++++++ .../awscc/athena/work_groups/index.md | 69 ++++ .../awscc/auditmanager/assessment/index.md | 90 ++++++ .../awscc/auditmanager/assessments/index.md | 62 ++++ .../providers/awscc/auditmanager/index.md | 39 +++ .../autoscaling/auto_scaling_group/index.md | 137 ++++++++ .../autoscaling/auto_scaling_groups/index.md | 69 ++++ .../providers/awscc/autoscaling/index.md | 49 +++ .../autoscaling/launch_configuration/index.md | 96 ++++++ .../launch_configurations/index.md | 60 ++++ .../awscc/autoscaling/lifecycle_hook/index.md | 81 +++++ .../autoscaling/lifecycle_hooks/index.md | 62 ++++ .../autoscaling/scaling_policies/index.md | 60 ++++ .../awscc/autoscaling/scaling_policy/index.md | 90 ++++++ .../autoscaling/scheduled_action/index.md | 81 +++++ .../autoscaling/scheduled_actions/index.md | 61 ++++ .../awscc/autoscaling/warm_pool/index.md | 74 +++++ .../awscc/autoscaling/warm_pools/index.md | 56 ++++ .../awscc/b2bi/capabilities/index.md | 73 +++++ .../providers/awscc/b2bi/capability/index.md | 82 +++++ docs/awscc-docs/providers/awscc/b2bi/index.md | 45 +++ .../providers/awscc/b2bi/partnership/index.md | 86 +++++ .../awscc/b2bi/partnerships/index.md | 60 ++++ .../providers/awscc/b2bi/profile/index.md | 88 +++++ .../providers/awscc/b2bi/profiles/index.md | 68 ++++ .../providers/awscc/b2bi/transformer/index.md | 88 +++++ .../awscc/b2bi/transformers/index.md | 69 ++++ .../awscc/backup/backup_plan/index.md | 76 +++++ .../awscc/backup/backup_plans/index.md | 60 ++++ .../awscc/backup/backup_selection/index.md | 66 ++++ .../awscc/backup/backup_selections/index.md | 61 ++++ .../awscc/backup/backup_vault/index.md | 87 +++++ .../awscc/backup/backup_vaults/index.md | 69 ++++ .../providers/awscc/backup/framework/index.md | 83 +++++ .../awscc/backup/frameworks/index.md | 62 ++++ .../providers/awscc/backup/index.md | 51 +++ .../awscc/backup/report_plan/index.md | 79 +++++ .../awscc/backup/report_plans/index.md | 62 ++++ .../backup/restore_testing_plan/index.md | 81 +++++ .../backup/restore_testing_plans/index.md | 61 ++++ .../backup/restore_testing_selection/index.md | 81 +++++ .../restore_testing_selections/index.md | 62 ++++ .../awscc/backupgateway/hypervisor/index.md | 84 +++++ .../awscc/backupgateway/hypervisors/index.md | 64 ++++ .../providers/awscc/backupgateway/index.md | 39 +++ .../awscc/batch/compute_environment/index.md | 92 ++++++ .../awscc/batch/compute_environments/index.md | 63 ++++ .../awscc-docs/providers/awscc/batch/index.md | 43 +++ .../providers/awscc/batch/job_queue/index.md | 80 +++++ .../providers/awscc/batch/job_queues/index.md | 60 ++++ .../awscc/batch/scheduling_policies/index.md | 60 ++++ .../awscc/batch/scheduling_policy/index.md | 72 +++++ .../billingconductor/billing_group/index.md | 98 ++++++ .../billingconductor/billing_groups/index.md | 65 ++++ .../custom_line_item/index.md | 100 ++++++ .../custom_line_items/index.md | 64 ++++ .../providers/awscc/billingconductor/index.md | 45 +++ .../billingconductor/pricing_plan/index.md | 87 +++++ .../billingconductor/pricing_plans/index.md | 64 ++++ .../billingconductor/pricing_rule/index.md | 97 ++++++ .../billingconductor/pricing_rules/index.md | 62 ++++ .../awscc/budgets/budgets_action/index.md | 81 +++++ .../awscc/budgets/budgets_actions/index.md | 62 ++++ .../providers/awscc/budgets/index.md | 39 +++ .../providers/awscc/cassandra/index.md | 41 +++ .../awscc/cassandra/keyspace/index.md | 78 +++++ .../awscc/cassandra/keyspaces/index.md | 65 ++++ .../providers/awscc/cassandra/table/index.md | 130 ++++++++ .../providers/awscc/cassandra/tables/index.md | 88 +++++ .../awscc/ce/anomaly_monitor/index.md | 81 +++++ .../awscc/ce/anomaly_monitors/index.md | 59 ++++ .../awscc/ce/anomaly_subscription/index.md | 79 +++++ .../awscc/ce/anomaly_subscriptions/index.md | 59 ++++ .../awscc/ce/cost_categories/index.md | 58 ++++ .../providers/awscc/ce/cost_category/index.md | 75 +++++ docs/awscc-docs/providers/awscc/ce/index.md | 43 +++ .../awscc/certificatemanager/account/index.md | 67 ++++ .../certificatemanager/accounts/index.md | 55 ++++ .../awscc/certificatemanager/index.md | 39 +++ .../providers/awscc/chatbot/index.md | 41 +++ .../index.md | 83 +++++ .../index.md | 60 ++++ .../slack_channel_configuration/index.md | 80 +++++ .../slack_channel_configurations/index.md | 60 ++++ .../cleanrooms/analysis_template/index.md | 97 ++++++ .../cleanrooms/analysis_templates/index.md | 64 ++++ .../awscc/cleanrooms/collaboration/index.md | 95 ++++++ .../awscc/cleanrooms/collaborations/index.md | 64 ++++ .../cleanrooms/configured_table/index.md | 111 +++++++ .../configured_table_association/index.md | 88 +++++ .../configured_table_associations/index.md | 65 ++++ .../cleanrooms/configured_tables/index.md | 74 +++++ .../providers/awscc/cleanrooms/index.md | 47 +++ .../awscc/cleanrooms/membership/index.md | 105 ++++++ .../awscc/cleanrooms/memberships/index.md | 72 +++++ .../providers/awscc/cloud_control/index.md | 49 +++ .../awscc/cloud_control/resource/index.md | 35 ++ .../cloud_control/resource_request/index.md | 43 +++ .../cloud_control/resource_requests/index.md | 44 +++ .../awscc/cloud_control/resources/index.md | 38 +++ .../hook_default_version/index.md | 69 ++++ .../hook_default_versions/index.md | 58 ++++ .../cloudformation/hook_type_config/index.md | 71 ++++ .../cloudformation/hook_type_configs/index.md | 59 ++++ .../cloudformation/hook_version/index.md | 76 +++++ .../cloudformation/hook_versions/index.md | 65 ++++ .../providers/awscc/cloudformation/index.md | 61 ++++ .../module_default_version/index.md | 63 ++++ .../module_default_versions/index.md | 59 ++++ .../cloudformation/module_version/index.md | 78 +++++ .../cloudformation/module_versions/index.md | 59 ++++ .../public_type_version/index.md | 74 +++++ .../public_type_versions/index.md | 63 ++++ .../awscc/cloudformation/publisher/index.md | 69 ++++ .../awscc/cloudformation/publishers/index.md | 61 ++++ .../resource_default_version/index.md | 69 ++++ .../resource_default_versions/index.md | 58 ++++ .../cloudformation/resource_version/index.md | 78 +++++ .../cloudformation/resource_versions/index.md | 66 ++++ .../awscc/cloudformation/stack/index.md | 114 +++++++ .../awscc/cloudformation/stack_set/index.md | 110 +++++++ .../awscc/cloudformation/stack_sets/index.md | 67 ++++ .../awscc/cloudformation/stacks/index.md | 60 ++++ .../cloudformation/type_activation/index.md | 86 +++++ .../cloudformation/type_activations/index.md | 60 ++++ .../awscc/cloudfront/cache_policies/index.md | 58 ++++ .../awscc/cloudfront/cache_policy/index.md | 68 ++++ .../index.md | 58 ++++ .../index.md | 68 ++++ .../continuous_deployment_policies/index.md | 58 ++++ .../continuous_deployment_policy/index.md | 68 ++++ .../awscc/cloudfront/distribution/index.md | 77 +++++ .../awscc/cloudfront/distributions/index.md | 62 ++++ .../awscc/cloudfront/function/index.md | 78 +++++ .../awscc/cloudfront/functions/index.md | 60 ++++ .../providers/awscc/cloudfront/index.md | 63 ++++ .../awscc/cloudfront/key_group/index.md | 68 ++++ .../awscc/cloudfront/key_groups/index.md | 58 ++++ .../awscc/cloudfront/key_value_store/index.md | 74 +++++ .../cloudfront/key_value_stores/index.md | 62 ++++ .../monitoring_subscription/index.md | 60 ++++ .../monitoring_subscriptions/index.md | 54 ++++ .../cloudfront/origin_access_control/index.md | 66 ++++ .../origin_access_controls/index.md | 58 ++++ .../origin_request_policies/index.md | 58 ++++ .../cloudfront/origin_request_policy/index.md | 68 ++++ .../awscc/cloudfront/public_key/index.md | 68 ++++ .../awscc/cloudfront/public_keys/index.md | 58 ++++ .../cloudfront/realtime_log_config/index.md | 73 +++++ .../cloudfront/realtime_log_configs/index.md | 59 ++++ .../response_headers_policies/index.md | 58 ++++ .../response_headers_policy/index.md | 68 ++++ .../awscc/cloudtrail/channel/index.md | 75 +++++ .../awscc/cloudtrail/channels/index.md | 59 ++++ .../cloudtrail/event_data_store/index.md | 126 ++++++++ .../cloudtrail/event_data_stores/index.md | 76 +++++ .../providers/awscc/cloudtrail/index.md | 45 +++ .../cloudtrail/resource_policies/index.md | 55 ++++ .../awscc/cloudtrail/resource_policy/index.md | 66 ++++ .../providers/awscc/cloudtrail/trail/index.md | 115 +++++++ .../awscc/cloudtrail/trails/index.md | 73 +++++ .../providers/awscc/cloudwatch/alarm/index.md | 107 +++++++ .../awscc/cloudwatch/alarms/index.md | 59 ++++ .../awscc/cloudwatch/composite_alarm/index.md | 85 +++++ .../cloudwatch/composite_alarms/index.md | 59 ++++ .../providers/awscc/cloudwatch/index.md | 43 +++ .../awscc/cloudwatch/metric_stream/index.md | 92 ++++++ .../awscc/cloudwatch/metric_streams/index.md | 61 ++++ .../awscc/codeartifact/domain/index.md | 82 +++++ .../awscc/codeartifact/domains/index.md | 62 ++++ .../providers/awscc/codeartifact/index.md | 41 +++ .../awscc/codeartifact/repositories/index.md | 63 ++++ .../awscc/codeartifact/repository/index.md | 92 ++++++ .../providers/awscc/codebuild/fleet/index.md | 75 +++++ .../providers/awscc/codebuild/fleets/index.md | 59 ++++ .../providers/awscc/codebuild/index.md | 39 +++ .../awscc/codedeploy/application/index.md | 70 ++++ .../awscc/codedeploy/applications/index.md | 59 ++++ .../codedeploy/deployment_config/index.md | 68 ++++ .../codedeploy/deployment_configs/index.md | 58 ++++ .../providers/awscc/codedeploy/index.md | 41 +++ .../providers/awscc/codeguruprofiler/index.md | 39 +++ .../codeguruprofiler/profiling_group/index.md | 83 +++++ .../profiling_groups/index.md | 63 ++++ .../providers/awscc/codegurureviewer/index.md | 39 +++ .../repository_association/index.md | 78 +++++ .../repository_associations/index.md | 73 +++++ .../codepipeline/custom_action_type/index.md | 85 +++++ .../codepipeline/custom_action_types/index.md | 64 ++++ .../providers/awscc/codepipeline/index.md | 39 +++ .../codestarconnections/connection/index.md | 78 +++++ .../codestarconnections/connections/index.md | 60 ++++ .../awscc/codestarconnections/index.md | 43 +++ .../repository_link/index.md | 87 +++++ .../repository_links/index.md | 64 ++++ .../sync_configuration/index.md | 83 +++++ .../sync_configurations/index.md | 63 ++++ .../awscc/codestarnotifications/index.md | 39 +++ .../notification_rule/index.md | 86 +++++ .../notification_rules/index.md | 58 ++++ .../awscc/cognito/identity_pool/index.md | 91 ++++++ .../identity_pool_principal_tag/index.md | 72 +++++ .../identity_pool_principal_tags/index.md | 61 ++++ .../identity_pool_role_attachment/index.md | 72 +++++ .../identity_pool_role_attachments/index.md | 60 ++++ .../awscc/cognito/identity_pools/index.md | 61 ++++ .../providers/awscc/cognito/index.md | 57 ++++ .../log_delivery_configuration/index.md | 85 +++++ .../log_delivery_configurations/index.md | 63 ++++ .../awscc/cognito/user_pool/index.md | 124 +++++++ .../awscc/cognito/user_pool_client/index.md | 116 +++++++ .../awscc/cognito/user_pool_clients/index.md | 63 ++++ .../awscc/cognito/user_pool_group/index.md | 76 +++++ .../awscc/cognito/user_pool_groups/index.md | 63 ++++ .../index.md | 75 +++++ .../index.md | 58 ++++ .../awscc/cognito/user_pool_user/index.md | 74 +++++ .../index.md | 66 ++++ .../index.md | 59 ++++ .../awscc/cognito/user_pool_users/index.md | 62 ++++ .../awscc/cognito/user_pools/index.md | 63 ++++ .../comprehend/document_classifier/index.md | 97 ++++++ .../comprehend/document_classifiers/index.md | 63 ++++ .../awscc/comprehend/flywheel/index.md | 86 +++++ .../awscc/comprehend/flywheels/index.md | 61 ++++ .../providers/awscc/comprehend/index.md | 41 +++ .../config/aggregation_authorization/index.md | 76 +++++ .../aggregation_authorizations/index.md | 62 ++++ .../awscc/config/config_rule/index.md | 84 +++++ .../awscc/config/config_rules/index.md | 59 ++++ .../config/configuration_aggregator/index.md | 80 +++++ .../config/configuration_aggregators/index.md | 63 ++++ .../awscc/config/conformance_pack/index.md | 81 +++++ .../awscc/config/conformance_packs/index.md | 64 ++++ .../providers/awscc/config/index.md | 49 +++ .../organization_conformance_pack/index.md | 86 +++++ .../organization_conformance_packs/index.md | 67 ++++ .../awscc/config/stored_queries/index.md | 60 ++++ .../awscc/config/stored_query/index.md | 79 +++++ .../awscc/connect/approved_origin/index.md | 67 ++++ .../awscc/connect/approved_origins/index.md | 61 ++++ .../awscc/connect/contact_flow/index.md | 81 +++++ .../connect/contact_flow_module/index.md | 81 +++++ .../connect/contact_flow_modules/index.md | 59 ++++ .../awscc/connect/contact_flows/index.md | 59 ++++ .../awscc/connect/evaluation_form/index.md | 84 +++++ .../awscc/connect/evaluation_forms/index.md | 60 ++++ .../awscc/connect/hours_of_operation/index.md | 78 +++++ .../connect/hours_of_operations/index.md | 59 ++++ .../providers/awscc/connect/index.md | 81 +++++ .../providers/awscc/connect/instance/index.md | 93 ++++++ .../connect/instance_storage_config/index.md | 97 ++++++ .../connect/instance_storage_configs/index.md | 73 +++++ .../awscc/connect/instances/index.md | 73 +++++ .../connect/integration_association/index.md | 90 ++++++ .../connect/integration_associations/index.md | 92 ++++++ .../connect/predefined_attribute/index.md | 68 ++++ .../connect/predefined_attributes/index.md | 60 ++++ .../providers/awscc/connect/prompt/index.md | 75 +++++ .../providers/awscc/connect/prompts/index.md | 62 ++++ .../providers/awscc/connect/queue/index.md | 93 ++++++ .../providers/awscc/connect/queues/index.md | 60 ++++ .../awscc/connect/quick_connect/index.md | 79 +++++ .../awscc/connect/quick_connects/index.md | 59 ++++ .../awscc/connect/routing_profile/index.md | 90 ++++++ .../awscc/connect/routing_profiles/index.md | 60 ++++ .../providers/awscc/connect/rule/index.md | 83 +++++ .../providers/awscc/connect/rules/index.md | 57 ++++ .../awscc/connect/security_key/index.md | 68 ++++ .../awscc/connect/security_keys/index.md | 60 ++++ .../awscc/connect/security_profile/index.md | 81 +++++ .../awscc/connect/security_profiles/index.md | 59 ++++ .../awscc/connect/task_template/index.md | 87 +++++ .../awscc/connect/task_templates/index.md | 59 ++++ .../traffic_distribution_group/index.md | 78 +++++ .../traffic_distribution_groups/index.md | 60 ++++ .../providers/awscc/connect/user/index.md | 96 ++++++ .../connect/user_hierarchy_group/index.md | 74 +++++ .../connect/user_hierarchy_groups/index.md | 59 ++++ .../providers/awscc/connect/users/index.md | 60 ++++ .../providers/awscc/connect/view/index.md | 83 +++++ .../awscc/connect/view_version/index.md | 71 ++++ .../awscc/connect/view_versions/index.md | 58 ++++ .../providers/awscc/connect/views/index.md | 59 ++++ .../awscc/connectcampaigns/campaign/index.md | 78 +++++ .../awscc/connectcampaigns/campaigns/index.md | 63 ++++ .../providers/awscc/connectcampaigns/index.md | 39 +++ .../controltower/enabled_baseline/index.md | 124 +++++++ .../controltower/enabled_baselines/index.md | 84 +++++ .../controltower/enabled_control/index.md | 93 ++++++ .../controltower/enabled_controls/index.md | 71 ++++ .../providers/awscc/controltower/index.md | 43 +++ .../awscc/controltower/landing_zone/index.md | 130 ++++++++ .../awscc/controltower/landing_zones/index.md | 88 +++++ docs/awscc-docs/providers/awscc/cur/index.md | 39 +++ .../awscc/cur/report_definition/index.md | 87 +++++ .../awscc/cur/report_definitions/index.md | 58 ++++ .../calculated_attribute_definition/index.md | 85 +++++ .../calculated_attribute_definitions/index.md | 61 ++++ .../awscc/customerprofiles/domain/index.md | 84 +++++ .../awscc/customerprofiles/domains/index.md | 59 ++++ .../customerprofiles/event_stream/index.md | 83 +++++ .../customerprofiles/event_streams/index.md | 63 ++++ .../providers/awscc/customerprofiles/index.md | 47 +++ .../customerprofiles/integration/index.md | 98 ++++++ .../customerprofiles/integrations/index.md | 69 ++++ .../customerprofiles/object_type/index.md | 91 ++++++ .../customerprofiles/object_types/index.md | 62 ++++ .../providers/awscc/databrew/dataset/index.md | 77 +++++ .../awscc/databrew/datasets/index.md | 65 ++++ .../providers/awscc/databrew/index.md | 49 +++ .../providers/awscc/databrew/job/index.md | 105 ++++++ .../providers/awscc/databrew/jobs/index.md | 64 ++++ .../providers/awscc/databrew/project/index.md | 76 +++++ .../awscc/databrew/projects/index.md | 63 ++++ .../providers/awscc/databrew/recipe/index.md | 71 ++++ .../providers/awscc/databrew/recipes/index.md | 63 ++++ .../providers/awscc/databrew/ruleset/index.md | 73 +++++ .../awscc/databrew/rulesets/index.md | 63 ++++ .../awscc/databrew/schedule/index.md | 71 ++++ .../awscc/databrew/schedules/index.md | 63 ++++ .../providers/awscc/datapipeline/index.md | 39 +++ .../awscc/datapipeline/pipeline/index.md | 91 ++++++ .../awscc/datapipeline/pipelines/index.md | 65 ++++ .../providers/awscc/datasync/agent/index.md | 82 +++++ .../providers/awscc/datasync/agents/index.md | 65 ++++ .../providers/awscc/datasync/index.md | 60 ++++ .../datasync/location_azure_blob/index.md | 86 +++++ .../datasync/location_azure_blobs/index.md | 61 ++++ .../awscc/datasync/location_efs/index.md | 83 +++++ .../awscc/datasync/location_hdfs/index.md | 96 ++++++ .../awscc/datasync/location_nfs/index.md | 80 +++++ .../datasync/location_object_storage/index.md | 90 ++++++ .../location_object_storages/index.md | 61 ++++ .../awscc/datasync/location_s3/index.md | 79 +++++ .../awscc/datasync/location_s3s/index.md | 65 ++++ .../awscc/datasync/location_smb/index.md | 86 +++++ .../awscc/datasync/location_smbs/index.md | 61 ++++ .../datasync/locationf_sx_lustre/index.md | 77 +++++ .../datasync/locationf_sx_lustres/index.md | 65 ++++ .../datasync/locationf_sx_ontap/index.md | 81 +++++ .../datasync/locationf_sx_ontaps/index.md | 66 ++++ .../datasync/locationf_sx_open_zfs/index.md | 79 +++++ .../datasync/locationf_sx_windows/index.md | 83 +++++ .../awscc/datasync/storage_system/index.md | 92 ++++++ .../awscc/datasync/storage_systems/index.md | 64 ++++ .../providers/awscc/datasync/task/index.md | 104 ++++++ .../providers/awscc/datasync/tasks/index.md | 76 +++++ .../awscc/datazone/data_source/index.md | 109 +++++++ .../awscc/datazone/data_sources/index.md | 63 ++++ .../providers/awscc/datazone/domain/index.md | 94 ++++++ .../providers/awscc/datazone/domains/index.md | 64 ++++ .../awscc/datazone/environment/index.md | 103 ++++++ .../index.md | 86 +++++ .../index.md | 63 ++++ .../datazone/environment_profile/index.md | 94 ++++++ .../datazone/environment_profiles/index.md | 61 ++++ .../awscc/datazone/environments/index.md | 62 ++++ .../providers/awscc/datazone/index.md | 51 +++ .../providers/awscc/datazone/project/index.md | 82 +++++ .../awscc/datazone/projects/index.md | 61 ++++ .../datazone/subscription_target/index.md | 99 ++++++ .../datazone/subscription_targets/index.md | 64 ++++ .../providers/awscc/detective/graph/index.md | 74 +++++ .../providers/awscc/detective/graphs/index.md | 63 ++++ .../providers/awscc/detective/index.md | 43 +++ .../detective/member_invitation/index.md | 72 +++++ .../detective/member_invitations/index.md | 62 ++++ .../detective/organization_admin/index.md | 68 ++++ .../detective/organization_admins/index.md | 65 ++++ .../providers/awscc/devopsguru/index.md | 43 +++ .../index.md | 68 ++++ .../index.md | 61 ++++ .../devopsguru/notification_channel/index.md | 62 ++++ .../devopsguru/notification_channels/index.md | 62 ++++ .../devopsguru/resource_collection/index.md | 67 ++++ .../devopsguru/resource_collections/index.md | 59 ++++ .../providers/awscc/directoryservice/index.md | 39 +++ .../awscc/directoryservice/simple_ad/index.md | 92 ++++++ .../directoryservice/simple_ads/index.md | 69 ++++ .../awscc/dms/data_provider/index.md | 85 +++++ .../awscc/dms/data_providers/index.md | 64 ++++ docs/awscc-docs/providers/awscc/dms/index.md | 45 +++ .../awscc/dms/instance_profile/index.md | 91 ++++++ .../awscc/dms/instance_profiles/index.md | 64 ++++ .../awscc/dms/migration_project/index.md | 94 ++++++ .../awscc/dms/migration_projects/index.md | 65 ++++ .../awscc/dms/replication_config/index.md | 95 ++++++ .../awscc/dms/replication_configs/index.md | 65 ++++ .../awscc/docdbelastic/cluster/index.md | 116 +++++++ .../awscc/docdbelastic/clusters/index.md | 77 +++++ .../providers/awscc/docdbelastic/index.md | 39 +++ .../awscc/dynamodb/global_table/index.md | 142 ++++++++ .../awscc/dynamodb/global_tables/index.md | 96 ++++++ .../providers/awscc/dynamodb/index.md | 41 +++ .../providers/awscc/dynamodb/table/index.md | 129 ++++++++ .../providers/awscc/dynamodb/tables/index.md | 93 ++++++ docs/awscc-docs/providers/awscc/ecr/index.md | 47 +++ .../awscc/ecr/public_repositories/index.md | 61 ++++ .../awscc/ecr/public_repository/index.md | 78 +++++ .../ecr/pull_through_cache_rule/index.md | 74 +++++ .../ecr/pull_through_cache_rules/index.md | 62 ++++ .../awscc/ecr/registry_policies/index.md | 59 ++++ .../awscc/ecr/registry_policy/index.md | 66 ++++ .../ecr/replication_configuration/index.md | 69 ++++ .../ecr/replication_configurations/index.md | 60 ++++ .../providers/awscc/ecr/repositories/index.md | 64 ++++ .../providers/awscc/ecr/repository/index.md | 97 ++++++ .../index.md | 69 ++++ docs/awscc-docs/providers/awscc/ecs/index.md | 46 +++ .../awscc/ecs/primary_task_set/index.md | 69 ++++ .../awscc/ecs/primary_task_sets/index.md | 57 ++++ .../providers/awscc/ecs/service/index.md | 117 +++++++ .../providers/awscc/ecs/services/index.md | 65 ++++ .../awscc/ecs/task_definition/index.md | 105 ++++++ .../awscc/ecs/task_definitions/index.md | 63 ++++ .../providers/awscc/ecs/task_set/index.md | 91 ++++++ .../providers/awscc/ecs/task_sets/index.md | 60 ++++ .../providers/awscc/efs/access_point/index.md | 79 +++++ .../awscc/efs/access_points/index.md | 60 ++++ .../providers/awscc/efs/file_system/index.md | 117 +++++++ .../providers/awscc/efs/file_systems/index.md | 73 +++++ docs/awscc-docs/providers/awscc/efs/index.md | 43 +++ .../providers/awscc/efs/mount_target/index.md | 75 +++++ .../awscc/efs/mount_targets/index.md | 60 ++++ .../awscc/eks/access_entries/index.md | 64 ++++ .../providers/awscc/eks/access_entry/index.md | 86 +++++ .../providers/awscc/eks/addon/index.md | 87 +++++ .../providers/awscc/eks/addons/index.md | 63 ++++ .../providers/awscc/eks/cluster/index.md | 102 ++++++ .../providers/awscc/eks/clusters/index.md | 74 +++++ .../awscc/eks/fargate_profile/index.md | 80 +++++ .../awscc/eks/fargate_profiles/index.md | 65 ++++ .../eks/identity_provider_config/index.md | 78 +++++ .../eks/identity_provider_configs/index.md | 65 ++++ docs/awscc-docs/providers/awscc/eks/index.md | 51 +++ .../providers/awscc/eks/nodegroup/index.md | 110 +++++++ .../providers/awscc/eks/nodegroups/index.md | 74 +++++ .../eks/pod_identity_association/index.md | 81 +++++ .../eks/pod_identity_associations/index.md | 62 ++++ .../global_replication_group/index.md | 91 ++++++ .../global_replication_groups/index.md | 59 ++++ .../providers/awscc/elasticache/index.md | 47 +++ .../elasticache/serverless_cache/index.md | 108 +++++++ .../elasticache/serverless_caches/index.md | 66 ++++ .../awscc/elasticache/subnet_group/index.md | 75 +++++ .../awscc/elasticache/subnet_groups/index.md | 61 ++++ .../providers/awscc/elasticache/user/index.md | 87 +++++ .../awscc/elasticache/user_group/index.md | 81 +++++ .../awscc/elasticache/user_groups/index.md | 61 ++++ .../awscc/elasticache/users/index.md | 61 ++++ .../elasticbeanstalk/application/index.md | 68 ++++ .../application_version/index.md | 70 ++++ .../application_versions/index.md | 63 ++++ .../elasticbeanstalk/applications/index.md | 58 ++++ .../configuration_template/index.md | 79 +++++ .../configuration_templates/index.md | 60 ++++ .../elasticbeanstalk/environment/index.md | 95 ++++++ .../elasticbeanstalk/environments/index.md | 60 ++++ .../providers/awscc/elasticbeanstalk/index.md | 45 +++ .../awscc/elasticloadbalancingv2/index.md | 49 +++ .../elasticloadbalancingv2/listener/index.md | 82 +++++ .../listener_rule/index.md | 76 +++++ .../listener_rules/index.md | 60 ++++ .../elasticloadbalancingv2/listeners/index.md | 60 ++++ .../load_balancer/index.md | 99 ++++++ .../load_balancers/index.md | 61 ++++ .../target_group/index.md | 118 +++++++ .../target_groups/index.md | 63 ++++ .../trust_store/index.md | 83 +++++ .../trust_store_revocation/index.md | 67 ++++ .../trust_store_revocations/index.md | 63 ++++ .../trust_stores/index.md | 64 ++++ docs/awscc-docs/providers/awscc/emr/index.md | 47 +++ .../awscc/emr/security_configuration/index.md | 61 ++++ .../emr/security_configurations/index.md | 59 ++++ .../providers/awscc/emr/step/index.md | 63 ++++ .../providers/awscc/emr/steps/index.md | 54 ++++ .../providers/awscc/emr/studio/index.md | 107 +++++++ .../awscc/emr/studio_session_mapping/index.md | 95 ++++++ .../emr/studio_session_mappings/index.md | 70 ++++ .../providers/awscc/emr/studios/index.md | 63 ++++ .../awscc/emr/wal_workspace/index.md | 67 ++++ .../awscc/emr/wal_workspaces/index.md | 60 ++++ .../providers/awscc/emrcontainers/index.md | 39 +++ .../emrcontainers/virtual_cluster/index.md | 74 +++++ .../emrcontainers/virtual_clusters/index.md | 60 ++++ .../awscc/emrserverless/application/index.md | 117 +++++++ .../awscc/emrserverless/applications/index.md | 81 +++++ .../providers/awscc/emrserverless/index.md | 39 +++ .../id_mapping_workflow/index.md | 91 ++++++ .../id_mapping_workflows/index.md | 63 ++++ .../providers/awscc/entityresolution/index.md | 43 +++ .../matching_workflow/index.md | 91 ++++++ .../matching_workflows/index.md | 63 ++++ .../entityresolution/schema_mapping/index.md | 83 +++++ .../entityresolution/schema_mappings/index.md | 60 ++++ .../awscc/events/api_destination/index.md | 77 +++++ .../awscc/events/api_destinations/index.md | 59 ++++ .../providers/awscc/events/archive/index.md | 75 +++++ .../providers/awscc/events/archives/index.md | 59 ++++ .../awscc/events/connection/index.md | 79 +++++ .../awscc/events/connections/index.md | 63 ++++ .../providers/awscc/events/endpoint/index.md | 87 +++++ .../providers/awscc/events/endpoints/index.md | 61 ++++ .../providers/awscc/events/event_bus/index.md | 76 +++++ .../awscc/events/event_buses/index.md | 63 ++++ .../providers/awscc/events/index.md | 49 +++ .../providers/awscc/events/rule/index.md | 89 ++++++ .../providers/awscc/events/rules/index.md | 61 ++++ .../awscc/eventschemas/discoverer/index.md | 85 +++++ .../awscc/eventschemas/discoverers/index.md | 65 ++++ .../eventschemas_registry/index.md | 74 +++++ .../providers/awscc/eventschemas/index.md | 45 +++ .../awscc/eventschemas/registries/index.md | 60 ++++ .../eventschemas/registry_policies/index.md | 56 ++++ .../eventschemas/registry_policy/index.md | 71 ++++ .../awscc/eventschemas/schema/index.md | 87 +++++ .../awscc/eventschemas/schemata/index.md | 61 ++++ .../awscc/evidently/experiment/index.md | 95 ++++++ .../awscc/evidently/experiments/index.md | 57 ++++ .../awscc/evidently/feature/index.md | 86 +++++ .../awscc/evidently/features/index.md | 56 ++++ .../providers/awscc/evidently/index.md | 47 +++ .../providers/awscc/evidently/launch/index.md | 90 ++++++ .../awscc/evidently/launches/index.md | 57 ++++ .../awscc/evidently/project/index.md | 112 +++++++ .../awscc/evidently/projects/index.md | 69 ++++ .../awscc/evidently/segment/index.md | 70 ++++ .../awscc/evidently/segments/index.md | 61 ++++ .../awscc/finspace/environment/index.md | 92 ++++++ .../awscc/finspace/environments/index.md | 61 ++++ .../providers/awscc/finspace/index.md | 39 +++ .../awscc/fis/experiment_template/index.md | 83 +++++ .../awscc/fis/experiment_templates/index.md | 61 ++++ docs/awscc-docs/providers/awscc/fis/index.md | 41 +++ .../fis/target_account_configuration/index.md | 70 ++++ .../target_account_configurations/index.md | 60 ++++ docs/awscc-docs/providers/awscc/fms/index.md | 43 +++ .../awscc/fms/notification_channel/index.md | 66 ++++ .../awscc/fms/notification_channels/index.md | 59 ++++ .../providers/awscc/fms/policies/index.md | 71 ++++ .../providers/awscc/fms/policy/index.md | 109 +++++++ .../providers/awscc/fms/resource_set/index.md | 82 +++++ .../awscc/fms/resource_sets/index.md | 61 ++++ .../providers/awscc/forecast/dataset/index.md | 73 +++++ .../awscc/forecast/dataset_group/index.md | 71 ++++ .../awscc/forecast/dataset_groups/index.md | 58 ++++ .../awscc/forecast/datasets/index.md | 58 ++++ .../providers/awscc/forecast/index.md | 41 +++ .../awscc/frauddetector/detector/index.md | 142 ++++++++ .../awscc/frauddetector/detectors/index.md | 89 ++++++ .../awscc/frauddetector/event_type/index.md | 110 +++++++ .../awscc/frauddetector/event_types/index.md | 74 +++++ .../frauddetector/frauddetector_list/index.md | 85 +++++ .../providers/awscc/frauddetector/index.md | 49 +++ .../awscc/frauddetector/label/index.md | 79 +++++ .../awscc/frauddetector/labels/index.md | 62 ++++ .../awscc/frauddetector/lists/index.md | 65 ++++ .../awscc/frauddetector/outcome/index.md | 79 +++++ .../awscc/frauddetector/outcomes/index.md | 62 ++++ .../awscc/frauddetector/variable/index.md | 87 +++++ .../awscc/frauddetector/variables/index.md | 62 ++++ .../fsx/data_repository_association/index.md | 88 +++++ .../fsx/data_repository_associations/index.md | 65 ++++ docs/awscc-docs/providers/awscc/fsx/index.md | 39 +++ .../providers/awscc/gamelift/alias/index.md | 69 ++++ .../providers/awscc/gamelift/aliases/index.md | 58 ++++ .../providers/awscc/gamelift/build/index.md | 74 +++++ .../providers/awscc/gamelift/builds/index.md | 59 ++++ .../providers/awscc/gamelift/fleet/index.md | 139 ++++++++ .../providers/awscc/gamelift/fleets/index.md | 64 ++++ .../awscc/gamelift/game_server_group/index.md | 114 +++++++ .../gamelift/game_server_groups/index.md | 82 +++++ .../gamelift/game_session_queue/index.md | 86 +++++ .../gamelift/game_session_queues/index.md | 60 ++++ .../providers/awscc/gamelift/index.md | 55 ++++ .../awscc/gamelift/location/index.md | 71 ++++ .../awscc/gamelift/locations/index.md | 61 ++++ .../matchmaking_configuration/index.md | 103 ++++++ .../matchmaking_configurations/index.md | 61 ++++ .../gamelift/matchmaking_rule_set/index.md | 76 +++++ .../gamelift/matchmaking_rule_sets/index.md | 62 ++++ .../providers/awscc/gamelift/script/index.md | 84 +++++ .../providers/awscc/gamelift/scripts/index.md | 63 ++++ .../globalaccelerator/accelerator/index.md | 85 +++++ .../globalaccelerator/accelerators/index.md | 60 ++++ .../globalaccelerator/endpoint_group/index.md | 87 +++++ .../endpoint_groups/index.md | 63 ++++ .../awscc/globalaccelerator/index.md | 43 +++ .../awscc/globalaccelerator/listener/index.md | 74 +++++ .../globalaccelerator/listeners/index.md | 60 ++++ docs/awscc-docs/providers/awscc/glue/index.md | 40 +++ .../awscc/glue/schema_version/index.md | 64 ++++ .../glue/schema_version_metadata/index.md | 65 ++++ .../awscc/glue/schema_versions/index.md | 60 ++++ .../providers/awscc/grafana/index.md | 39 +++ .../awscc/grafana/workspace/index.md | 131 ++++++++ .../awscc/grafana/workspaces/index.md | 76 +++++ .../greengrassv2/component_version/index.md | 77 +++++ .../greengrassv2/component_versions/index.md | 63 ++++ .../awscc/greengrassv2/deployment/index.md | 88 +++++ .../awscc/greengrassv2/deployments/index.md | 73 +++++ .../providers/awscc/greengrassv2/index.md | 41 +++ .../awscc/groundstation/config/index.md | 78 +++++ .../awscc/groundstation/configs/index.md | 60 ++++ .../dataflow_endpoint_group/index.md | 71 ++++ .../dataflow_endpoint_groups/index.md | 64 ++++ .../providers/awscc/groundstation/index.md | 43 +++ .../groundstation/mission_profile/index.md | 97 ++++++ .../groundstation/mission_profiles/index.md | 65 ++++ .../awscc/guardduty/detector/index.md | 79 +++++ .../awscc/guardduty/detectors/index.md | 62 ++++ .../providers/awscc/guardduty/filter/index.md | 81 +++++ .../awscc/guardduty/filters/index.md | 62 ++++ .../providers/awscc/guardduty/index.md | 49 +++ .../providers/awscc/guardduty/ip_set/index.md | 84 +++++ .../awscc/guardduty/ip_sets/index.md | 63 ++++ .../providers/awscc/guardduty/master/index.md | 64 ++++ .../awscc/guardduty/masters/index.md | 62 ++++ .../providers/awscc/guardduty/member/index.md | 81 +++++ .../awscc/guardduty/members/index.md | 61 ++++ .../awscc/guardduty/threat_intel_set/index.md | 83 +++++ .../guardduty/threat_intel_sets/index.md | 63 ++++ .../awscc/healthimaging/datastore/index.md | 80 +++++ .../awscc/healthimaging/datastores/index.md | 68 ++++ .../providers/awscc/healthimaging/index.md | 39 +++ .../awscc/healthlake/fhir_datastore/index.md | 98 ++++++ .../awscc/healthlake/fhir_datastores/index.md | 74 +++++ .../providers/awscc/healthlake/index.md | 39 +++ .../providers/awscc/iam/group/index.md | 85 +++++ .../awscc/iam/group_policies/index.md | 57 ++++ .../providers/awscc/iam/group_policy/index.md | 69 ++++ .../providers/awscc/iam/groups/index.md | 62 ++++ docs/awscc-docs/providers/awscc/iam/index.md | 63 ++++ .../awscc/iam/instance_profile/index.md | 73 +++++ .../awscc/iam/instance_profiles/index.md | 61 ++++ .../awscc/iam/managed_policies/index.md | 61 ++++ .../awscc/iam/managed_policy/index.md | 108 +++++++ .../awscc/iam/oidc_provider/index.md | 76 +++++ .../awscc/iam/oidc_providers/index.md | 61 ++++ .../providers/awscc/iam/role/index.md | 102 ++++++ .../awscc/iam/role_policies/index.md | 57 ++++ .../providers/awscc/iam/role_policy/index.md | 69 ++++ .../providers/awscc/iam/roles/index.md | 64 ++++ .../awscc/iam/saml_provider/index.md | 72 +++++ .../awscc/iam/saml_providers/index.md | 61 ++++ .../awscc/iam/server_certificate/index.md | 77 +++++ .../awscc/iam/server_certificates/index.md | 61 ++++ .../awscc/iam/service_linked_role/index.md | 71 ++++ .../awscc/iam/service_linked_roles/index.md | 55 ++++ .../providers/awscc/iam/user/index.md | 111 +++++++ .../awscc/iam/user_policies/index.md | 57 ++++ .../providers/awscc/iam/user_policy/index.md | 69 ++++ .../providers/awscc/iam/users/index.md | 64 ++++ .../awscc/iam/virtualmfa_device/index.md | 72 +++++ .../awscc/iam/virtualmfa_devices/index.md | 60 ++++ .../awscc/identitystore/group/index.md | 72 +++++ .../identitystore/group_membership/index.md | 67 ++++ .../identitystore/group_memberships/index.md | 61 ++++ .../awscc/identitystore/groups/index.md | 61 ++++ .../providers/awscc/identitystore/index.md | 41 +++ .../awscc/imagebuilder/component/index.md | 85 +++++ .../awscc/imagebuilder/components/index.md | 68 ++++ .../imagebuilder/container_recipe/index.md | 91 ++++++ .../imagebuilder/container_recipes/index.md | 73 +++++ .../distribution_configuration/index.md | 77 +++++ .../distribution_configurations/index.md | 65 ++++ .../awscc/imagebuilder/image/index.md | 88 +++++ .../imagebuilder/image_pipeline/index.md | 96 ++++++ .../imagebuilder/image_pipelines/index.md | 69 ++++ .../awscc/imagebuilder/image_recipe/index.md | 79 +++++ .../awscc/imagebuilder/image_recipes/index.md | 65 ++++ .../awscc/imagebuilder/images/index.md | 69 ++++ .../providers/awscc/imagebuilder/index.md | 55 ++++ .../infrastructure_configuration/index.md | 94 ++++++ .../infrastructure_configurations/index.md | 65 ++++ .../imagebuilder/lifecycle_policies/index.md | 61 ++++ .../imagebuilder/lifecycle_policy/index.md | 83 +++++ .../awscc/imagebuilder/workflow/index.md | 79 +++++ .../awscc/imagebuilder/workflows/index.md | 67 ++++ .../inspector/assessment_target/index.md | 68 ++++ .../inspector/assessment_targets/index.md | 60 ++++ .../inspector/assessment_template/index.md | 69 ++++ .../inspector/assessment_templates/index.md | 60 ++++ .../providers/awscc/inspector/index.md | 43 +++ .../awscc/inspector/resource_group/index.md | 61 ++++ .../awscc/inspector/resource_groups/index.md | 54 ++++ .../cis_scan_configuration/index.md | 80 +++++ .../cis_scan_configurations/index.md | 61 ++++ .../awscc/inspectorv2/filter/index.md | 73 +++++ .../awscc/inspectorv2/filters/index.md | 59 ++++ .../providers/awscc/inspectorv2/index.md | 41 +++ .../providers/awscc/internetmonitor/index.md | 39 +++ .../awscc/internetmonitor/monitor/index.md | 109 +++++++ .../awscc/internetmonitor/monitors/index.md | 69 ++++ .../iot/account_audit_configuration/index.md | 72 +++++ .../iot/account_audit_configurations/index.md | 60 ++++ .../providers/awscc/iot/authorizer/index.md | 86 +++++ .../providers/awscc/iot/authorizers/index.md | 61 ++++ .../awscc/iot/billing_group/index.md | 77 +++++ .../awscc/iot/billing_groups/index.md | 62 ++++ .../awscc/iot/ca_certificate/index.md | 90 ++++++ .../awscc/iot/ca_certificates/index.md | 63 ++++ .../providers/awscc/iot/certificate/index.md | 78 +++++ .../awscc/iot/certificate_provider/index.md | 77 +++++ .../awscc/iot/certificate_providers/index.md | 61 ++++ .../providers/awscc/iot/certificates/index.md | 61 ++++ .../awscc/iot/custom_metric/index.md | 76 +++++ .../awscc/iot/custom_metrics/index.md | 59 ++++ .../providers/awscc/iot/dimension/index.md | 76 +++++ .../providers/awscc/iot/dimensions/index.md | 59 ++++ .../awscc/iot/domain_configuration/index.md | 94 ++++++ .../awscc/iot/domain_configurations/index.md | 63 ++++ .../providers/awscc/iot/fleet_metric/index.md | 95 ++++++ .../awscc/iot/fleet_metrics/index.md | 60 ++++ docs/awscc-docs/providers/awscc/iot/index.md | 89 ++++++ .../providers/awscc/iot/job_template/index.md | 85 +++++ .../awscc/iot/job_templates/index.md | 61 ++++ .../providers/awscc/iot/logging/index.md | 70 ++++ .../providers/awscc/iot/loggings/index.md | 60 ++++ .../awscc/iot/mitigation_action/index.md | 79 +++++ .../awscc/iot/mitigation_actions/index.md | 61 ++++ .../providers/awscc/iot/policies/index.md | 61 ++++ .../providers/awscc/iot/policy/index.md | 82 +++++ .../awscc/iot/provisioning_template/index.md | 90 ++++++ .../awscc/iot/provisioning_templates/index.md | 63 ++++ .../iot/resource_specific_logging/index.md | 71 ++++ .../iot/resource_specific_loggings/index.md | 59 ++++ .../providers/awscc/iot/role_alias/index.md | 81 +++++ .../providers/awscc/iot/role_aliases/index.md | 63 ++++ .../awscc/iot/scheduled_audit/index.md | 80 +++++ .../awscc/iot/scheduled_audits/index.md | 60 ++++ .../awscc/iot/security_profile/index.md | 89 ++++++ .../awscc/iot/security_profiles/index.md | 62 ++++ .../awscc/iot/software_package/index.md | 83 +++++ .../iot/software_package_version/index.md | 87 +++++ .../iot/software_package_versions/index.md | 63 ++++ .../awscc/iot/software_packages/index.md | 61 ++++ .../providers/awscc/iot/thing/index.md | 71 ++++ .../providers/awscc/iot/thing_group/index.md | 83 +++++ .../providers/awscc/iot/thing_groups/index.md | 63 ++++ .../providers/awscc/iot/thing_type/index.md | 81 +++++ .../providers/awscc/iot/thing_types/index.md | 63 ++++ .../providers/awscc/iot/things/index.md | 59 ++++ .../providers/awscc/iot/topic_rule/index.md | 76 +++++ .../awscc/iot/topic_rule_destination/index.md | 74 +++++ .../iot/topic_rule_destinations/index.md | 61 ++++ .../providers/awscc/iot/topic_rules/index.md | 62 ++++ .../awscc/iotanalytics/dataset/index.md | 82 +++++ .../awscc/iotanalytics/datasets/index.md | 58 ++++ .../providers/awscc/iotanalytics/index.md | 41 +++ .../awscc/iotanalytics/pipeline/index.md | 72 +++++ .../awscc/iotanalytics/pipelines/index.md | 58 ++++ .../awscc/iotcoredeviceadvisor/index.md | 39 +++ .../suite_definition/index.md | 86 +++++ .../suite_definitions/index.md | 69 ++++ .../awscc/iotevents/alarm_model/index.md | 87 +++++ .../awscc/iotevents/alarm_models/index.md | 63 ++++ .../awscc/iotevents/detector_model/index.md | 83 +++++ .../awscc/iotevents/detector_models/index.md | 63 ++++ .../providers/awscc/iotevents/index.md | 43 +++ .../providers/awscc/iotevents/input/index.md | 75 +++++ .../providers/awscc/iotevents/inputs/index.md | 61 ++++ .../awscc/iotfleethub/application/index.md | 90 ++++++ .../awscc/iotfleethub/applications/index.md | 62 ++++ .../providers/awscc/iotfleethub/index.md | 39 +++ .../awscc/iotfleetwise/campaign/index.md | 109 +++++++ .../awscc/iotfleetwise/campaigns/index.md | 65 ++++ .../iotfleetwise/decoder_manifest/index.md | 91 ++++++ .../iotfleetwise/decoder_manifests/index.md | 64 ++++ .../awscc/iotfleetwise/fleet/index.md | 81 +++++ .../awscc/iotfleetwise/fleets/index.md | 62 ++++ .../providers/awscc/iotfleetwise/index.md | 49 +++ .../iotfleetwise/model_manifest/index.md | 87 +++++ .../iotfleetwise/model_manifests/index.md | 63 ++++ .../iotfleetwise/signal_catalog/index.md | 85 +++++ .../iotfleetwise/signal_catalogs/index.md | 62 ++++ .../awscc/iotfleetwise/vehicle/index.md | 85 +++++ .../awscc/iotfleetwise/vehicles/index.md | 64 ++++ .../iotsitewise/access_policies/index.md | 58 ++++ .../awscc/iotsitewise/access_policy/index.md | 73 +++++ .../awscc/iotsitewise/asset/index.md | 94 ++++++ .../awscc/iotsitewise/asset_model/index.md | 83 +++++ .../awscc/iotsitewise/asset_models/index.md | 63 ++++ .../awscc/iotsitewise/assets/index.md | 66 ++++ .../awscc/iotsitewise/dashboard/index.md | 83 +++++ .../awscc/iotsitewise/dashboards/index.md | 63 ++++ .../awscc/iotsitewise/gateway/index.md | 81 +++++ .../awscc/iotsitewise/gateways/index.md | 67 ++++ .../providers/awscc/iotsitewise/index.md | 51 +++ .../awscc/iotsitewise/portal/index.md | 95 ++++++ .../awscc/iotsitewise/portals/index.md | 64 ++++ .../awscc/iotsitewise/project/index.md | 85 +++++ .../awscc/iotsitewise/projects/index.md | 63 ++++ .../iottwinmaker/component_type/index.md | 103 ++++++ .../iottwinmaker/component_types/index.md | 67 ++++ .../awscc/iottwinmaker/entities/index.md | 69 ++++ .../awscc/iottwinmaker/entity/index.md | 105 ++++++ .../providers/awscc/iottwinmaker/index.md | 47 +++ .../awscc/iottwinmaker/scene/index.md | 93 ++++++ .../awscc/iottwinmaker/scenes/index.md | 66 ++++ .../awscc/iottwinmaker/sync_job/index.md | 78 +++++ .../awscc/iottwinmaker/sync_jobs/index.md | 67 ++++ .../awscc/iottwinmaker/workspace/index.md | 83 +++++ .../awscc/iottwinmaker/workspaces/index.md | 64 ++++ .../awscc/iotwireless/destination/index.md | 79 +++++ .../awscc/iotwireless/destinations/index.md | 62 ++++ .../awscc/iotwireless/device_profile/index.md | 68 ++++ .../iotwireless/device_profiles/index.md | 61 ++++ .../awscc/iotwireless/fuota_task/index.md | 95 ++++++ .../awscc/iotwireless/fuota_tasks/index.md | 63 ++++ .../providers/awscc/iotwireless/index.md | 59 ++++ .../iotwireless/multicast_group/index.md | 84 +++++ .../iotwireless/multicast_groups/index.md | 61 ++++ .../network_analyzer_configuration/index.md | 78 +++++ .../network_analyzer_configurations/index.md | 61 ++++ .../iotwireless/partner_account/index.md | 82 +++++ .../iotwireless/partner_accounts/index.md | 61 ++++ .../iotwireless/service_profile/index.md | 68 ++++ .../iotwireless/service_profiles/index.md | 61 ++++ .../iotwireless/task_definition/index.md | 74 +++++ .../iotwireless/task_definitions/index.md | 63 ++++ .../iotwireless/wireless_device/index.md | 90 ++++++ .../wireless_device_import_task/index.md | 89 ++++++ .../wireless_device_import_tasks/index.md | 63 ++++ .../iotwireless/wireless_devices/index.md | 61 ++++ .../iotwireless/wireless_gateway/index.md | 84 +++++ .../iotwireless/wireless_gateways/index.md | 61 ++++ .../providers/awscc/ivs/channel/index.md | 89 ++++++ .../providers/awscc/ivs/channels/index.md | 60 ++++ docs/awscc-docs/providers/awscc/ivs/index.md | 47 +++ .../awscc/ivs/playback_key_pair/index.md | 75 +++++ .../awscc/ivs/playback_key_pairs/index.md | 60 ++++ .../ivs/recording_configuration/index.md | 89 ++++++ .../ivs/recording_configurations/index.md | 68 ++++ .../providers/awscc/ivs/stage/index.md | 75 +++++ .../providers/awscc/ivs/stages/index.md | 62 ++++ .../providers/awscc/ivs/stream_key/index.md | 74 +++++ .../providers/awscc/ivs/stream_keys/index.md | 61 ++++ .../providers/awscc/ivschat/index.md | 41 +++ .../ivschat/logging_configuration/index.md | 95 ++++++ .../ivschat/logging_configurations/index.md | 69 ++++ .../providers/awscc/ivschat/room/index.md | 82 +++++ .../providers/awscc/ivschat/rooms/index.md | 60 ++++ .../awscc/kafkaconnect/connector/index.md | 102 ++++++ .../awscc/kafkaconnect/connectors/index.md | 74 +++++ .../providers/awscc/kafkaconnect/index.md | 39 +++ .../awscc/kendra/data_source/index.md | 93 ++++++ .../awscc/kendra/data_sources/index.md | 64 ++++ .../providers/awscc/kendra/faq/index.md | 84 +++++ .../providers/awscc/kendra/faqs/index.md | 64 ++++ .../providers/awscc/kendra/index.md | 43 +++ .../providers/awscc/kendra/index/index.md | 92 ++++++ .../providers/awscc/kendra/indices/index.md | 63 ++++ .../kendraranking/execution_plan/index.md | 79 +++++ .../kendraranking/execution_plans/index.md | 62 ++++ .../providers/awscc/kendraranking/index.md | 39 +++ .../providers/awscc/kinesis/index.md | 39 +++ .../awscc/kinesis/kinesis_stream/index.md | 89 ++++++ .../providers/awscc/kinesis/streams/index.md | 64 ++++ .../kinesisanalyticsv2/application/index.md | 88 +++++ .../kinesisanalyticsv2/applications/index.md | 62 ++++ .../awscc/kinesisanalyticsv2/index.md | 39 +++ .../kinesisfirehose/delivery_stream/index.md | 106 ++++++ .../kinesisfirehose/delivery_streams/index.md | 63 ++++ .../providers/awscc/kinesisfirehose/index.md | 39 +++ .../providers/awscc/kinesisvideo/index.md | 41 +++ .../kinesisvideo/kinesisvideo_stream/index.md | 78 +++++ .../kinesisvideo/signaling_channel/index.md | 73 +++++ .../kinesisvideo/signaling_channels/index.md | 55 ++++ .../awscc/kinesisvideo/streams/index.md | 55 ++++ .../providers/awscc/kms/alias/index.md | 65 ++++ .../providers/awscc/kms/aliases/index.md | 58 ++++ docs/awscc-docs/providers/awscc/kms/index.md | 43 +++ .../providers/awscc/kms/key/index.md | 100 ++++++ .../providers/awscc/kms/keys/index.md | 63 ++++ .../providers/awscc/kms/replica_key/index.md | 86 +++++ .../providers/awscc/kms/replica_keys/index.md | 63 ++++ .../lakeformation/data_cells_filter/index.md | 74 +++++ .../lakeformation/data_cells_filters/index.md | 65 ++++ .../providers/awscc/lakeformation/index.md | 44 +++ .../principal_permissions/index.md | 77 +++++ .../awscc/lakeformation/tag/index.md | 67 ++++ .../lakeformation/tag_association/index.md | 70 ++++ .../lakeformation/tag_associations/index.md | 58 ++++ .../awscc/lakeformation/tags/index.md | 58 ++++ .../awscc/lambda/code_signing_config/index.md | 71 ++++ .../lambda/code_signing_configs/index.md | 58 ++++ .../awscc/lambda/event_invoke_config/index.md | 72 +++++ .../lambda/event_invoke_configs/index.md | 60 ++++ .../lambda/event_source_mapping/index.md | 111 +++++++ .../lambda/event_source_mappings/index.md | 59 ++++ .../providers/awscc/lambda/function/index.md | 147 +++++++++ .../providers/awscc/lambda/functions/index.md | 82 +++++ .../providers/awscc/lambda/index.md | 55 ++++ .../awscc/lambda/layer_version/index.md | 72 +++++ .../lambda/layer_version_permission/index.md | 68 ++++ .../lambda/layer_version_permissions/index.md | 58 ++++ .../awscc/lambda/layer_versions/index.md | 60 ++++ .../awscc/lambda/permission/index.md | 76 +++++ .../awscc/lambda/permissions/index.md | 60 ++++ .../providers/awscc/lambda/url/index.md | 75 +++++ .../providers/awscc/lambda/urls/index.md | 58 ++++ .../providers/awscc/lambda/version/index.md | 78 +++++ .../providers/awscc/lambda/versions/index.md | 63 ++++ .../providers/awscc/lex/bot/index.md | 127 ++++++++ .../providers/awscc/lex/bot_alias/index.md | 88 +++++ .../providers/awscc/lex/bot_aliases/index.md | 61 ++++ .../providers/awscc/lex/bot_version/index.md | 67 ++++ .../providers/awscc/lex/bot_versions/index.md | 64 ++++ .../providers/awscc/lex/bots/index.md | 87 +++++ docs/awscc-docs/providers/awscc/lex/index.md | 45 +++ .../awscc/lex/resource_policies/index.md | 59 ++++ .../awscc/lex/resource_policy/index.md | 71 ++++ .../awscc/licensemanager/grant/index.md | 77 +++++ .../awscc/licensemanager/grants/index.md | 58 ++++ .../providers/awscc/licensemanager/index.md | 41 +++ .../awscc/licensemanager/license/index.md | 87 +++++ .../awscc/licensemanager/licenses/index.md | 58 ++++ .../providers/awscc/lightsail/alarm/index.md | 89 ++++++ .../providers/awscc/lightsail/alarms/index.md | 59 ++++ .../providers/awscc/lightsail/bucket/index.md | 88 +++++ .../awscc/lightsail/buckets/index.md | 65 ++++ .../awscc/lightsail/certificate/index.md | 76 +++++ .../awscc/lightsail/certificates/index.md | 61 ++++ .../awscc/lightsail/container/index.md | 88 +++++ .../awscc/lightsail/containers/index.md | 63 ++++ .../awscc/lightsail/database/index.md | 101 ++++++ .../awscc/lightsail/databases/index.md | 65 ++++ .../awscc/lightsail/distribution/index.md | 96 ++++++ .../awscc/lightsail/distributions/index.md | 67 ++++ .../providers/awscc/lightsail/index.md | 57 ++++ .../awscc/lightsail/instance/index.md | 116 +++++++ .../awscc/lightsail/instances/index.md | 71 ++++ .../awscc/lightsail/load_balancer/index.md | 91 ++++++ .../load_balancer_tls_certificate/index.md | 84 +++++ .../load_balancer_tls_certificates/index.md | 65 ++++ .../awscc/lightsail/load_balancers/index.md | 66 ++++ .../awscc/lightsail/static_ip/index.md | 78 +++++ .../awscc/lightsail/static_ips/index.md | 63 ++++ .../providers/awscc/location/api_key/index.md | 100 ++++++ .../awscc/location/api_keys/index.md | 71 ++++ .../location/geofence_collection/index.md | 89 ++++++ .../location/geofence_collections/index.md | 63 ++++ .../providers/awscc/location/index.md | 51 +++ .../providers/awscc/location/map/index.md | 84 +++++ .../providers/awscc/location/maps/index.md | 61 ++++ .../awscc/location/place_index/index.md | 86 +++++ .../awscc/location/place_indices/index.md | 61 ++++ .../awscc/location/route_calculator/index.md | 84 +++++ .../awscc/location/route_calculators/index.md | 61 ++++ .../providers/awscc/location/tracker/index.md | 95 ++++++ .../awscc/location/tracker_consumer/index.md | 63 ++++ .../awscc/location/tracker_consumers/index.md | 61 ++++ .../awscc/location/trackers/index.md | 63 ++++ .../awscc/logs/account_policies/index.md | 70 ++++ .../awscc/logs/account_policy/index.md | 89 ++++++ .../providers/awscc/logs/deliveries/index.md | 65 ++++ .../providers/awscc/logs/delivery/index.md | 79 +++++ .../awscc/logs/delivery_destination/index.md | 83 +++++ .../awscc/logs/delivery_destinations/index.md | 65 ++++ .../awscc/logs/delivery_source/index.md | 80 +++++ .../awscc/logs/delivery_sources/index.md | 65 ++++ .../providers/awscc/logs/destination/index.md | 74 +++++ .../awscc/logs/destinations/index.md | 61 ++++ docs/awscc-docs/providers/awscc/logs/index.md | 59 ++++ .../awscc/logs/log_anomaly_detector/index.md | 83 +++++ .../awscc/logs/log_anomaly_detectors/index.md | 58 ++++ .../providers/awscc/logs/log_stream/index.md | 62 ++++ .../providers/awscc/logs/log_streams/index.md | 60 ++++ .../awscc/logs/metric_filter/index.md | 71 ++++ .../awscc/logs/metric_filters/index.md | 61 ++++ .../awscc/logs/query_definition/index.md | 69 ++++ .../awscc/logs/query_definitions/index.md | 58 ++++ .../awscc/logs/resource_policies/index.md | 59 ++++ .../awscc/logs/resource_policy/index.md | 67 ++++ .../awscc/logs/subscription_filter/index.md | 76 +++++ .../awscc/logs/subscription_filters/index.md | 62 ++++ .../providers/awscc/lookoutequipment/index.md | 39 +++ .../inference_scheduler/index.md | 86 +++++ .../inference_schedulers/index.md | 60 ++++ .../awscc/lookoutmetrics/alert/index.md | 69 ++++ .../awscc/lookoutmetrics/alerts/index.md | 59 ++++ .../lookoutmetrics/anomaly_detector/index.md | 77 +++++ .../lookoutmetrics/anomaly_detectors/index.md | 61 ++++ .../providers/awscc/lookoutmetrics/index.md | 41 +++ .../providers/awscc/lookoutvision/index.md | 39 +++ .../awscc/lookoutvision/project/index.md | 65 ++++ .../awscc/lookoutvision/projects/index.md | 58 ++++ .../providers/awscc/m2/application/index.md | 90 ++++++ .../providers/awscc/m2/applications/index.md | 66 ++++ .../providers/awscc/m2/environment/index.md | 98 ++++++ .../providers/awscc/m2/environments/index.md | 76 +++++ docs/awscc-docs/providers/awscc/m2/index.md | 41 +++ .../providers/awscc/macie/allow_list/index.md | 78 +++++ .../awscc/macie/allow_lists/index.md | 60 ++++ .../macie/custom_data_identifier/index.md | 80 +++++ .../macie/custom_data_identifiers/index.md | 60 ++++ .../awscc/macie/findings_filter/index.md | 80 +++++ .../awscc/macie/findings_filters/index.md | 60 ++++ .../awscc-docs/providers/awscc/macie/index.md | 45 +++ .../providers/awscc/macie/session/index.md | 70 ++++ .../providers/awscc/macie/sessions/index.md | 59 ++++ .../awscc/managedblockchain/accessor/index.md | 80 +++++ .../managedblockchain/accessors/index.md | 60 ++++ .../awscc/managedblockchain/index.md | 39 +++ .../awscc/mediaconnect/bridge/index.md | 81 +++++ .../awscc/mediaconnect/bridge_output/index.md | 69 ++++ .../mediaconnect/bridge_outputs/index.md | 57 ++++ .../awscc/mediaconnect/bridge_source/index.md | 71 ++++ .../mediaconnect/bridge_sources/index.md | 57 ++++ .../awscc/mediaconnect/bridges/index.md | 59 ++++ .../awscc/mediaconnect/flow/index.md | 76 +++++ .../mediaconnect/flow_entitlement/index.md | 79 +++++ .../mediaconnect/flow_entitlements/index.md | 59 ++++ .../awscc/mediaconnect/flow_output/index.md | 93 ++++++ .../awscc/mediaconnect/flow_outputs/index.md | 59 ++++ .../awscc/mediaconnect/flow_source/index.md | 105 ++++++ .../awscc/mediaconnect/flow_sources/index.md | 61 ++++ .../mediaconnect/flow_vpc_interface/index.md | 77 +++++ .../mediaconnect/flow_vpc_interfaces/index.md | 62 ++++ .../awscc/mediaconnect/flows/index.md | 59 ++++ .../awscc/mediaconnect/gateway/index.md | 69 ++++ .../awscc/mediaconnect/gateways/index.md | 60 ++++ .../providers/awscc/mediaconnect/index.md | 55 ++++ .../providers/awscc/medialive/index.md | 41 +++ .../awscc/medialive/multiplex/index.md | 85 +++++ .../awscc/medialive/multiplexes/index.md | 60 ++++ .../awscc/medialive/multiplexprogram/index.md | 78 +++++ .../medialive/multiplexprograms/index.md | 61 ++++ .../awscc/mediapackage/asset/index.md | 76 +++++ .../awscc/mediapackage/assets/index.md | 62 ++++ .../awscc/mediapackage/channel/index.md | 77 +++++ .../awscc/mediapackage/channels/index.md | 63 ++++ .../providers/awscc/mediapackage/index.md | 47 +++ .../mediapackage/origin_endpoint/index.md | 94 ++++++ .../mediapackage/origin_endpoints/index.md | 63 ++++ .../packaging_configuration/index.md | 74 +++++ .../packaging_configurations/index.md | 62 ++++ .../mediapackage/packaging_group/index.md | 79 +++++ .../mediapackage/packaging_groups/index.md | 63 ++++ .../awscc/mediapackagev2/channel/index.md | 81 +++++ .../mediapackagev2/channel_group/index.md | 79 +++++ .../mediapackagev2/channel_groups/index.md | 59 ++++ .../mediapackagev2/channel_policies/index.md | 57 ++++ .../mediapackagev2/channel_policy/index.md | 70 ++++ .../awscc/mediapackagev2/channels/index.md | 59 ++++ .../providers/awscc/mediapackagev2/index.md | 47 +++ .../mediapackagev2/origin_endpoint/index.md | 92 ++++++ .../origin_endpoint_policies/index.md | 59 ++++ .../origin_endpoint_policy/index.md | 73 +++++ .../mediapackagev2/origin_endpoints/index.md | 60 ++++ .../awscc/mediatailor/channel/index.md | 85 +++++ .../mediatailor/channel_policies/index.md | 55 ++++ .../awscc/mediatailor/channel_policy/index.md | 67 ++++ .../awscc/mediatailor/channels/index.md | 62 ++++ .../providers/awscc/mediatailor/index.md | 49 +++ .../awscc/mediatailor/live_source/index.md | 76 +++++ .../awscc/mediatailor/live_sources/index.md | 62 ++++ .../playback_configuration/index.md | 101 ++++++ .../playback_configurations/index.md | 62 ++++ .../mediatailor/source_location/index.md | 82 +++++ .../mediatailor/source_locations/index.md | 63 ++++ .../awscc/mediatailor/vod_source/index.md | 76 +++++ .../awscc/mediatailor/vod_sources/index.md | 62 ++++ .../providers/awscc/memorydb/acl/index.md | 78 +++++ .../providers/awscc/memorydb/acls/index.md | 62 ++++ .../providers/awscc/memorydb/cluster/index.md | 123 +++++++ .../awscc/memorydb/clusters/index.md | 60 ++++ .../providers/awscc/memorydb/index.md | 47 +++ .../awscc/memorydb/parameter_group/index.md | 80 +++++ .../awscc/memorydb/parameter_groups/index.md | 61 ++++ .../awscc/memorydb/subnet_group/index.md | 77 +++++ .../awscc/memorydb/subnet_groups/index.md | 61 ++++ .../providers/awscc/memorydb/user/index.md | 79 +++++ .../providers/awscc/memorydb/users/index.md | 62 ++++ .../awscc/msk/batch_scram_secret/index.md | 76 +++++ .../awscc/msk/batch_scram_secrets/index.md | 65 ++++ .../providers/awscc/msk/cluster/index.md | 121 +++++++ .../awscc/msk/cluster_policies/index.md | 59 ++++ .../awscc/msk/cluster_policy/index.md | 69 ++++ .../providers/awscc/msk/clusters/index.md | 80 +++++ .../awscc/msk/configuration/index.md | 75 +++++ .../awscc/msk/configurations/index.md | 59 ++++ docs/awscc-docs/providers/awscc/msk/index.md | 51 +++ .../providers/awscc/msk/replicator/index.md | 85 +++++ .../providers/awscc/msk/replicators/index.md | 70 ++++ .../awscc/msk/serverless_cluster/index.md | 69 ++++ .../awscc/msk/serverless_clusters/index.md | 67 ++++ .../awscc/msk/vpc_connection/index.md | 88 +++++ .../awscc/msk/vpc_connections/index.md | 77 +++++ .../providers/awscc/mwaa/environment/index.md | 119 +++++++ .../awscc/mwaa/environments/index.md | 58 ++++ docs/awscc-docs/providers/awscc/mwaa/index.md | 39 +++ .../awscc/neptune/db_cluster/index.md | 142 ++++++++ .../awscc/neptune/db_clusters/index.md | 70 ++++ .../providers/awscc/neptune/index.md | 39 +++ .../awscc/neptunegraph/graph/index.md | 97 ++++++ .../awscc/neptunegraph/graphs/index.md | 70 ++++ .../providers/awscc/neptunegraph/index.md | 41 +++ .../private_graph_endpoint/index.md | 84 +++++ .../private_graph_endpoints/index.md | 71 ++++ .../awscc/networkfirewall/firewall/index.md | 103 ++++++ .../firewall_policies/index.md | 62 ++++ .../networkfirewall/firewall_policy/index.md | 81 +++++ .../awscc/networkfirewall/firewalls/index.md | 69 ++++ .../providers/awscc/networkfirewall/index.md | 47 +++ .../logging_configuration/index.md | 86 +++++ .../logging_configurations/index.md | 71 ++++ .../awscc/networkfirewall/rule_group/index.md | 85 +++++ .../networkfirewall/rule_groups/index.md | 63 ++++ .../tls_inspection_configuration/index.md | 79 +++++ .../tls_inspection_configurations/index.md | 60 ++++ .../connect_attachment/index.md | 99 ++++++ .../connect_attachments/index.md | 61 ++++ .../networkmanager/connect_peer/index.md | 93 ++++++ .../networkmanager/connect_peers/index.md | 61 ++++ .../networkmanager/core_network/index.md | 96 ++++++ .../networkmanager/core_networks/index.md | 62 ++++ .../customer_gateway_association/index.md | 66 ++++ .../customer_gateway_associations/index.md | 61 ++++ .../awscc/networkmanager/device/index.md | 95 ++++++ .../awscc/networkmanager/devices/index.md | 62 ++++ .../networkmanager/global_network/index.md | 78 +++++ .../networkmanager/global_networks/index.md | 61 ++++ .../providers/awscc/networkmanager/index.md | 65 ++++ .../awscc/networkmanager/link/index.md | 89 ++++++ .../networkmanager/link_association/index.md | 65 ++++ .../networkmanager/link_associations/index.md | 63 ++++ .../awscc/networkmanager/links/index.md | 62 ++++ .../awscc/networkmanager/site/index.md | 83 +++++ .../site_to_site_vpn_attachment/index.md | 97 ++++++ .../site_to_site_vpn_attachments/index.md | 61 ++++ .../awscc/networkmanager/sites/index.md | 62 ++++ .../transit_gateway_peering/index.md | 92 ++++++ .../transit_gateway_peerings/index.md | 64 ++++ .../transit_gateway_registration/index.md | 63 ++++ .../transit_gateway_registrations/index.md | 61 ++++ .../index.md | 99 ++++++ .../index.md | 62 ++++ .../networkmanager/vpc_attachment/index.md | 103 ++++++ .../networkmanager/vpc_attachments/index.md | 62 ++++ .../providers/awscc/nimblestudio/index.md | 45 +++ .../nimblestudio/launch_profile/index.md | 87 +++++ .../nimblestudio/launch_profiles/index.md | 66 ++++ .../nimblestudio/streaming_image/index.md | 96 ++++++ .../nimblestudio/streaming_images/index.md | 73 +++++ .../awscc/nimblestudio/studio/index.md | 101 ++++++ .../nimblestudio/studio_component/index.md | 97 ++++++ .../nimblestudio/studio_components/index.md | 67 ++++ .../awscc/nimblestudio/studios/index.md | 67 ++++ docs/awscc-docs/providers/awscc/oam/index.md | 41 +++ .../providers/awscc/oam/link/index.md | 81 +++++ .../providers/awscc/oam/links/index.md | 63 ++++ .../providers/awscc/oam/sink/index.md | 76 +++++ .../providers/awscc/oam/sinks/index.md | 61 ++++ .../awscc/omics/annotation_store/index.md | 94 ++++++ .../awscc/omics/annotation_stores/index.md | 65 ++++ .../awscc-docs/providers/awscc/omics/index.md | 49 +++ .../awscc/omics/reference_store/index.md | 72 +++++ .../awscc/omics/reference_stores/index.md | 59 ++++ .../providers/awscc/omics/run_group/index.md | 84 +++++ .../providers/awscc/omics/run_groups/index.md | 59 ++++ .../awscc/omics/sequence_store/index.md | 74 +++++ .../awscc/omics/sequence_stores/index.md | 59 ++++ .../awscc/omics/variant_store/index.md | 90 ++++++ .../awscc/omics/variant_stores/index.md | 65 ++++ .../providers/awscc/omics/workflow/index.md | 94 ++++++ .../providers/awscc/omics/workflows/index.md | 70 ++++ .../access_policies/index.md | 61 ++++ .../access_policy/index.md | 72 +++++ .../opensearchserverless/collection/index.md | 81 +++++ .../opensearchserverless/collections/index.md | 60 ++++ .../awscc/opensearchserverless/index.md | 49 +++ .../lifecycle_policies/index.md | 60 ++++ .../lifecycle_policy/index.md | 71 ++++ .../security_config/index.md | 72 +++++ .../security_configs/index.md | 58 ++++ .../security_policies/index.md | 63 ++++ .../security_policy/index.md | 75 +++++ .../vpc_endpoint/index.md | 105 ++++++ .../vpc_endpoints/index.md | 76 +++++ .../awscc/opensearchservice/domain/index.md | 119 +++++++ .../awscc/opensearchservice/domains/index.md | 57 ++++ .../awscc/opensearchservice/index.md | 39 +++ .../providers/awscc/opsworkscm/index.md | 39 +++ .../awscc/opsworkscm/server/index.md | 111 +++++++ .../awscc/opsworkscm/servers/index.md | 61 ++++ .../awscc/organizations/account/index.md | 89 ++++++ .../awscc/organizations/accounts/index.md | 64 ++++ .../providers/awscc/organizations/index.md | 47 +++ .../awscc/organizations/organization/index.md | 77 +++++ .../organizational_unit/index.md | 78 +++++ .../organizational_units/index.md | 62 ++++ .../organizations/organizations/index.md | 61 ++++ .../awscc/organizations/policies/index.md | 63 ++++ .../awscc/organizations/policy/index.md | 89 ++++++ .../organizations/resource_policies/index.md | 61 ++++ .../organizations/resource_policy/index.md | 74 +++++ docs/awscc-docs/providers/awscc/osis/index.md | 39 +++ .../providers/awscc/osis/pipeline/index.md | 99 ++++++ .../providers/awscc/osis/pipelines/index.md | 65 ++++ .../panorama/application_instance/index.md | 113 +++++++ .../panorama/application_instances/index.md | 70 ++++ .../providers/awscc/panorama/index.md | 43 +++ .../providers/awscc/panorama/package/index.md | 93 ++++++ .../awscc/panorama/package_version/index.md | 102 ++++++ .../awscc/panorama/package_versions/index.md | 63 ++++ .../awscc/panorama/packages/index.md | 68 ++++ .../awscc/pcaconnectorad/connector/index.md | 77 +++++ .../awscc/pcaconnectorad/connectors/index.md | 67 ++++ .../directory_registration/index.md | 74 +++++ .../directory_registrations/index.md | 61 ++++ .../providers/awscc/pcaconnectorad/index.md | 47 +++ .../service_principal_name/index.md | 64 ++++ .../service_principal_names/index.md | 62 ++++ .../awscc/pcaconnectorad/template/index.md | 78 +++++ .../index.md | 60 ++++ .../index.md | 71 ++++ .../awscc/pcaconnectorad/templates/index.md | 58 ++++ .../awscc/personalize/dataset/index.md | 77 +++++ .../awscc/personalize/dataset_group/index.md | 68 ++++ .../awscc/personalize/dataset_groups/index.md | 60 ++++ .../awscc/personalize/datasets/index.md | 62 ++++ .../providers/awscc/personalize/index.md | 45 +++ .../awscc/personalize/schema/index.md | 66 ++++ .../awscc/personalize/schemata/index.md | 59 ++++ .../awscc/personalize/solution/index.md | 74 +++++ .../awscc/personalize/solutions/index.md | 59 ++++ .../awscc/pinpoint/in_app_template/index.md | 78 +++++ .../awscc/pinpoint/in_app_templates/index.md | 61 ++++ .../providers/awscc/pinpoint/index.md | 39 +++ .../awscc-docs/providers/awscc/pipes/index.md | 39 +++ .../providers/awscc/pipes/pipe/index.md | 117 +++++++ .../providers/awscc/pipes/pipes/index.md | 71 ++++ .../environment_account_connection/index.md | 94 ++++++ .../environment_account_connections/index.md | 62 ++++ .../proton/environment_template/index.md | 85 +++++ .../proton/environment_templates/index.md | 61 ++++ .../providers/awscc/proton/index.md | 43 +++ .../awscc/proton/service_template/index.md | 86 +++++ .../awscc/proton/service_templates/index.md | 61 ++++ docs/awscc-docs/providers/awscc/qldb/index.md | 39 +++ .../providers/awscc/qldb/qldb_stream/index.md | 84 +++++ .../providers/awscc/qldb/streams/index.md | 62 ++++ .../awscc/quicksight/analyses/index.md | 68 ++++ .../awscc/quicksight/analysis/index.md | 108 +++++++ .../awscc/quicksight/dashboard/index.md | 114 +++++++ .../awscc/quicksight/dashboards/index.md | 68 ++++ .../awscc/quicksight/data_set/index.md | 128 ++++++++ .../awscc/quicksight/data_sets/index.md | 71 ++++ .../awscc/quicksight/data_source/index.md | 105 ++++++ .../awscc/quicksight/data_sources/index.md | 65 ++++ .../providers/awscc/quicksight/index.md | 55 ++++ .../quicksight/refresh_schedule/index.md | 73 +++++ .../quicksight/refresh_schedules/index.md | 63 ++++ .../awscc/quicksight/template/index.md | 98 ++++++ .../awscc/quicksight/templates/index.md | 66 ++++ .../providers/awscc/quicksight/theme/index.md | 97 ++++++ .../awscc/quicksight/themes/index.md | 65 ++++ .../providers/awscc/quicksight/topic/index.md | 78 +++++ .../awscc/quicksight/topics/index.md | 62 ++++ .../awscc/quicksight/vpc_connection/index.md | 101 ++++++ .../awscc/quicksight/vpc_connections/index.md | 64 ++++ docs/awscc-docs/providers/awscc/ram/index.md | 39 +++ .../providers/awscc/ram/permission/index.md | 86 +++++ .../providers/awscc/ram/permissions/index.md | 60 ++++ .../rds/customdb_engine_version/index.md | 86 +++++ .../rds/customdb_engine_versions/index.md | 74 +++++ .../providers/awscc/rds/db_cluster/index.md | 198 ++++++++++++ .../rds/db_cluster_parameter_group/index.md | 82 +++++ .../rds/db_cluster_parameter_groups/index.md | 67 ++++ .../providers/awscc/rds/db_clusters/index.md | 71 ++++ .../providers/awscc/rds/db_instance/index.md | 256 +++++++++++++++ .../providers/awscc/rds/db_instances/index.md | 87 +++++ .../awscc/rds/db_parameter_group/index.md | 81 +++++ .../awscc/rds/db_parameter_groups/index.md | 66 ++++ .../providers/awscc/rds/db_proxies/index.md | 60 ++++ .../providers/awscc/rds/db_proxy/index.md | 91 ++++++ .../awscc/rds/db_proxy_endpoint/index.md | 85 +++++ .../awscc/rds/db_proxy_endpoints/index.md | 59 ++++ .../awscc/rds/db_proxy_target_group/index.md | 77 +++++ .../awscc/rds/db_proxy_target_groups/index.md | 61 ++++ .../awscc/rds/db_subnet_group/index.md | 76 +++++ .../awscc/rds/db_subnet_groups/index.md | 63 ++++ .../awscc/rds/event_subscription/index.md | 83 +++++ .../awscc/rds/event_subscriptions/index.md | 63 ++++ .../awscc/rds/global_cluster/index.md | 77 +++++ .../awscc/rds/global_clusters/index.md | 60 ++++ docs/awscc-docs/providers/awscc/rds/index.md | 63 ++++ .../providers/awscc/rds/integration/index.md | 80 +++++ .../providers/awscc/rds/integrations/index.md | 63 ++++ .../providers/awscc/rds/option_group/index.md | 81 +++++ .../awscc/rds/option_groups/index.md | 64 ++++ .../providers/awscc/redshift/cluster/index.md | 204 ++++++++++++ .../redshift/cluster_parameter_group/index.md | 85 +++++ .../cluster_parameter_groups/index.md | 76 +++++ .../redshift/cluster_subnet_group/index.md | 106 ++++++ .../redshift/cluster_subnet_groups/index.md | 82 +++++ .../awscc/redshift/clusters/index.md | 90 ++++++ .../awscc/redshift/endpoint_access/index.md | 107 +++++++ .../awscc/redshift/endpoint_accesses/index.md | 73 +++++ .../redshift/endpoint_authorization/index.md | 96 ++++++ .../redshift/endpoint_authorizations/index.md | 61 ++++ .../redshift/event_subscription/index.md | 97 ++++++ .../redshift/event_subscriptions/index.md | 62 ++++ .../providers/awscc/redshift/index.md | 51 +++ .../awscc/redshift/scheduled_action/index.md | 90 ++++++ .../awscc/redshift/scheduled_actions/index.md | 65 ++++ .../awscc/redshiftserverless/index.md | 41 +++ .../redshiftserverless/namespace/index.md | 132 ++++++++ .../redshiftserverless/namespaces/index.md | 82 +++++ .../redshiftserverless/workgroup/index.md | 111 +++++++ .../redshiftserverless/workgroups/index.md | 74 +++++ .../awscc/refactorspaces/application/index.md | 102 ++++++ .../refactorspaces/applications/index.md | 86 +++++ .../awscc/refactorspaces/environment/index.md | 81 +++++ .../refactorspaces/environments/index.md | 85 +++++ .../providers/awscc/refactorspaces/index.md | 45 +++ .../awscc/refactorspaces/route/index.md | 130 ++++++++ .../awscc/refactorspaces/routes/index.md | 84 +++++ .../awscc/refactorspaces/service/index.md | 94 ++++++ .../awscc/refactorspaces/services/index.md | 75 +++++ .../awscc/rekognition/collection/index.md | 71 ++++ .../awscc/rekognition/collections/index.md | 61 ++++ .../providers/awscc/rekognition/index.md | 43 +++ .../awscc/rekognition/project/index.md | 66 ++++ .../awscc/rekognition/projects/index.md | 58 ++++ .../rekognition/stream_processor/index.md | 97 ++++++ .../rekognition/stream_processors/index.md | 62 ++++ .../awscc/resiliencehub/app/index.md | 107 +++++++ .../awscc/resiliencehub/apps/index.md | 77 +++++ .../providers/awscc/resiliencehub/index.md | 41 +++ .../resiliency_policies/index.md | 60 ++++ .../resiliencehub/resiliency_policy/index.md | 81 +++++ .../default_view_association/index.md | 67 ++++ .../default_view_associations/index.md | 55 ++++ .../awscc/resourceexplorer2/index.md | 43 +++ .../awscc/resourceexplorer2/index/index.md | 75 +++++ .../awscc/resourceexplorer2/indices/index.md | 63 ++++ .../awscc/resourceexplorer2/view/index.md | 78 +++++ .../awscc/resourceexplorer2/views/index.md | 59 ++++ .../awscc/resourcegroups/group/index.md | 90 ++++++ .../awscc/resourcegroups/groups/index.md | 63 ++++ .../providers/awscc/resourcegroups/index.md | 39 +++ .../providers/awscc/robomaker/fleet/index.md | 68 ++++ .../providers/awscc/robomaker/fleets/index.md | 58 ++++ .../providers/awscc/robomaker/index.md | 49 +++ .../providers/awscc/robomaker/robot/index.md | 76 +++++ .../robomaker/robot_application/index.md | 82 +++++ .../robot_application_version/index.md | 66 ++++ .../robot_application_versions/index.md | 60 ++++ .../robomaker/robot_applications/index.md | 65 ++++ .../providers/awscc/robomaker/robots/index.md | 59 ++++ .../robomaker/simulation_application/index.md | 86 +++++ .../simulation_application_version/index.md | 66 ++++ .../simulation_application_versions/index.md | 60 ++++ .../simulation_applications/index.md | 65 ++++ .../awscc/rolesanywhere/crl/index.md | 79 +++++ .../awscc/rolesanywhere/crls/index.md | 61 ++++ .../providers/awscc/rolesanywhere/index.md | 43 +++ .../awscc/rolesanywhere/profile/index.md | 90 ++++++ .../awscc/rolesanywhere/profiles/index.md | 64 ++++ .../awscc/rolesanywhere/trust_anchor/index.md | 85 +++++ .../rolesanywhere/trust_anchors/index.md | 62 ++++ .../awscc/route53/cidr_collection/index.md | 70 ++++ .../awscc/route53/cidr_collections/index.md | 60 ++++ .../providers/awscc/route53/dnssec/index.md | 63 ++++ .../providers/awscc/route53/dnssecs/index.md | 64 ++++ .../awscc/route53/health_check/index.md | 70 ++++ .../awscc/route53/health_checks/index.md | 62 ++++ .../awscc/route53/hosted_zone/index.md | 87 +++++ .../awscc/route53/hosted_zones/index.md | 67 ++++ .../providers/awscc/route53/index.md | 47 +++ .../awscc/route53/key_signing_key/index.md | 80 +++++ .../awscc/route53/key_signing_keys/index.md | 65 ++++ .../route53recoverycontrol/cluster/index.md | 69 ++++ .../route53recoverycontrol/clusters/index.md | 61 ++++ .../control_panel/index.md | 81 +++++ .../control_panels/index.md | 62 ++++ .../awscc/route53recoverycontrol/index.md | 45 +++ .../routing_control/index.md | 74 +++++ .../routing_controls/index.md | 61 ++++ .../safety_rule/index.md | 83 +++++ .../safety_rules/index.md | 63 ++++ .../route53recoveryreadiness/cell/index.md | 77 +++++ .../route53recoveryreadiness/cells/index.md | 61 ++++ .../awscc/route53recoveryreadiness/index.md | 45 +++ .../readiness_check/index.md | 76 +++++ .../readiness_checks/index.md | 63 ++++ .../recovery_group/index.md | 76 +++++ .../recovery_groups/index.md | 62 ++++ .../resource_set/index.md | 79 +++++ .../resource_sets/index.md | 63 ++++ .../firewall_domain_list/index.md | 102 ++++++ .../firewall_domain_lists/index.md | 68 ++++ .../firewall_rule_group/index.md | 102 ++++++ .../firewall_rule_group_association/index.md | 104 ++++++ .../firewall_rule_group_associations/index.md | 68 ++++ .../firewall_rule_groups/index.md | 68 ++++ .../providers/awscc/route53resolver/index.md | 57 ++++ .../route53resolver/outpost_resolver/index.md | 93 ++++++ .../outpost_resolvers/index.md | 62 ++++ .../route53resolver/resolver_config/index.md | 70 ++++ .../route53resolver/resolver_configs/index.md | 61 ++++ .../resolver_query_logging_config/index.md | 81 +++++ .../index.md | 76 +++++ .../index.md | 63 ++++ .../resolver_query_logging_configs/index.md | 71 ++++ .../route53resolver/resolver_rule/index.md | 83 +++++ .../resolver_rule_association/index.md | 66 ++++ .../resolver_rule_associations/index.md | 60 ++++ .../route53resolver/resolver_rules/index.md | 61 ++++ .../resolverdnssec_config/index.md | 69 ++++ .../resolverdnssec_configs/index.md | 62 ++++ .../providers/awscc/rum/app_monitor/index.md | 118 +++++++ .../providers/awscc/rum/app_monitors/index.md | 88 +++++ docs/awscc-docs/providers/awscc/rum/index.md | 39 +++ .../providers/awscc/s3/access_grant/index.md | 81 +++++ .../providers/awscc/s3/access_grants/index.md | 59 ++++ .../awscc/s3/access_grants_instance/index.md | 69 ++++ .../awscc/s3/access_grants_instances/index.md | 59 ++++ .../awscc/s3/access_grants_location/index.md | 73 +++++ .../awscc/s3/access_grants_locations/index.md | 60 ++++ .../providers/awscc/s3/access_point/index.md | 85 +++++ .../providers/awscc/s3/access_points/index.md | 60 ++++ .../providers/awscc/s3/bucket/index.md | 158 +++++++++ .../awscc/s3/bucket_policies/index.md | 60 ++++ .../providers/awscc/s3/bucket_policy/index.md | 67 ++++ .../providers/awscc/s3/buckets/index.md | 82 +++++ docs/awscc-docs/providers/awscc/s3/index.md | 56 ++++ .../s3/multi_region_access_point/index.md | 69 ++++ .../index.md | 59 ++++ .../multi_region_access_point_policy/index.md | 70 ++++ .../s3/multi_region_access_points/index.md | 60 ++++ .../providers/awscc/s3/storage_lens/index.md | 75 +++++ .../awscc/s3/storage_lens_group/index.md | 74 +++++ .../awscc/s3/storage_lens_groups/index.md | 61 ++++ .../awscc/s3express/bucket_policies/index.md | 60 ++++ .../awscc/s3express/bucket_policy/index.md | 67 ++++ .../awscc/s3express/directory_bucket/index.md | 66 ++++ .../s3express/directory_buckets/index.md | 59 ++++ .../providers/awscc/s3express/index.md | 41 +++ .../s3objectlambda/access_point/index.md | 80 +++++ .../access_point_policies/index.md | 55 ++++ .../access_point_policy/index.md | 67 ++++ .../s3objectlambda/access_points/index.md | 62 ++++ .../providers/awscc/s3objectlambda/index.md | 41 +++ .../awscc/s3outposts/access_point/index.md | 76 +++++ .../awscc/s3outposts/access_points/index.md | 61 ++++ .../awscc/s3outposts/bucket/index.md | 75 +++++ .../awscc/s3outposts/bucket_policies/index.md | 55 ++++ .../awscc/s3outposts/bucket_policy/index.md | 67 ++++ .../awscc/s3outposts/buckets/index.md | 60 ++++ .../awscc/s3outposts/endpoint/index.md | 81 +++++ .../awscc/s3outposts/endpoints/index.md | 58 ++++ .../providers/awscc/s3outposts/index.md | 45 +++ .../providers/awscc/sagemaker/app/index.md | 76 +++++ .../awscc/sagemaker/app_image_config/index.md | 73 +++++ .../sagemaker/app_image_configs/index.md | 59 ++++ .../providers/awscc/sagemaker/apps/index.md | 65 ++++ .../data_quality_job_definition/index.md | 83 +++++ .../data_quality_job_definitions/index.md | 62 ++++ .../providers/awscc/sagemaker/device/index.md | 67 ++++ .../awscc/sagemaker/device_fleet/index.md | 72 +++++ .../awscc/sagemaker/device_fleets/index.md | 55 ++++ .../awscc/sagemaker/devices/index.md | 54 ++++ .../awscc/sagemaker/feature_group/index.md | 91 ++++++ .../awscc/sagemaker/feature_groups/index.md | 68 ++++ .../providers/awscc/sagemaker/image/index.md | 80 +++++ .../awscc/sagemaker/image_version/index.md | 94 ++++++ .../awscc/sagemaker/image_versions/index.md | 59 ++++ .../providers/awscc/sagemaker/images/index.md | 62 ++++ .../providers/awscc/sagemaker/index.md | 79 +++++ .../sagemaker/inference_component/index.md | 93 ++++++ .../sagemaker/inference_components/index.md | 63 ++++ .../sagemaker/inference_experiment/index.md | 107 +++++++ .../sagemaker/inference_experiments/index.md | 62 ++++ .../model_bias_job_definition/index.md | 83 +++++ .../model_bias_job_definitions/index.md | 62 ++++ .../awscc/sagemaker/model_card/index.md | 104 ++++++ .../awscc/sagemaker/model_cards/index.md | 65 ++++ .../index.md | 83 +++++ .../index.md | 62 ++++ .../awscc/sagemaker/model_package/index.md | 121 +++++++ .../sagemaker/model_package_group/index.md | 87 +++++ .../sagemaker/model_package_groups/index.md | 63 ++++ .../awscc/sagemaker/model_packages/index.md | 71 ++++ .../model_quality_job_definition/index.md | 83 +++++ .../model_quality_job_definitions/index.md | 62 ++++ .../sagemaker/monitoring_schedule/index.md | 83 +++++ .../sagemaker/monitoring_schedules/index.md | 60 ++++ .../awscc/sagemaker/pipeline/index.md | 82 +++++ .../awscc/sagemaker/pipelines/index.md | 63 ++++ .../awscc/sagemaker/project/index.md | 86 +++++ .../awscc/sagemaker/projects/index.md | 66 ++++ .../providers/awscc/sagemaker/space/index.md | 82 +++++ .../providers/awscc/sagemaker/spaces/index.md | 61 ++++ .../awscc/sagemaker/user_profile/index.md | 81 +++++ .../awscc/sagemaker/user_profiles/index.md | 64 ++++ .../providers/awscc/scheduler/index.md | 41 +++ .../awscc/scheduler/schedule/index.md | 88 +++++ .../awscc/scheduler/schedule_group/index.md | 79 +++++ .../awscc/scheduler/schedule_groups/index.md | 61 ++++ .../awscc/scheduler/schedules/index.md | 60 ++++ .../providers/awscc/secretsmanager/index.md | 39 +++ .../awscc/secretsmanager/secret/index.md | 86 +++++ .../awscc/secretsmanager/secrets/index.md | 61 ++++ .../securityhub/automation_rule/index.md | 91 ++++++ .../securityhub/automation_rules/index.md | 61 ++++ .../providers/awscc/securityhub/hub/index.md | 78 +++++ .../providers/awscc/securityhub/hubs/index.md | 62 ++++ .../providers/awscc/securityhub/index.md | 43 +++ .../awscc/securityhub/standard/index.md | 70 ++++ .../awscc/securityhub/standards/index.md | 60 ++++ .../index.md | 93 ++++++ .../index.md | 54 ++++ .../providers/awscc/servicecatalog/index.md | 43 +++ .../servicecatalog/service_action/index.md | 75 +++++ .../service_action_association/index.md | 66 ++++ .../service_action_associations/index.md | 63 ++++ .../servicecatalog/service_actions/index.md | 60 ++++ .../application/index.md | 82 +++++ .../applications/index.md | 60 ++++ .../attribute_group/index.md | 77 +++++ .../attribute_group_association/index.md | 66 ++++ .../attribute_group_associations/index.md | 60 ++++ .../attribute_groups/index.md | 59 ++++ .../awscc/servicecatalogappregistry/index.md | 45 +++ .../resource_association/index.md | 69 ++++ .../resource_associations/index.md | 63 ++++ .../awscc/ses/configuration_set/index.md | 81 +++++ .../index.md | 69 ++++ .../index.md | 56 ++++ .../awscc/ses/configuration_sets/index.md | 58 ++++ .../providers/awscc/ses/contact_list/index.md | 71 ++++ .../awscc/ses/contact_lists/index.md | 58 ++++ .../awscc/ses/dedicated_ip_pool/index.md | 67 ++++ .../awscc/ses/dedicated_ip_pools/index.md | 60 ++++ .../awscc/ses/email_identities/index.md | 62 ++++ .../awscc/ses/email_identity/index.md | 90 ++++++ docs/awscc-docs/providers/awscc/ses/index.md | 50 +++ .../providers/awscc/ses/template/index.md | 70 ++++ .../providers/awscc/ses/templates/index.md | 62 ++++ .../awscc/ses/vdm_attributes/index.md | 69 ++++ .../awscc/shield/drt_access/index.md | 84 +++++ .../awscc/shield/drt_accesses/index.md | 65 ++++ .../providers/awscc/shield/index.md | 45 +++ .../shield/proactive_engagement/index.md | 74 +++++ .../shield/proactive_engagements/index.md | 63 ++++ .../awscc/shield/protection/index.md | 89 ++++++ .../awscc/shield/protection_group/index.md | 79 +++++ .../awscc/shield/protection_groups/index.md | 59 ++++ .../awscc/shield/protections/index.md | 71 ++++ .../providers/awscc/signer/index.md | 41 +++ .../awscc/signer/profile_permission/index.md | 69 ++++ .../awscc/signer/profile_permissions/index.md | 62 ++++ .../awscc/signer/signing_profile/index.md | 78 +++++ .../awscc/signer/signing_profiles/index.md | 59 ++++ .../providers/awscc/simspaceweaver/index.md | 39 +++ .../awscc/simspaceweaver/simulation/index.md | 78 +++++ .../awscc/simspaceweaver/simulations/index.md | 61 ++++ docs/awscc-docs/providers/awscc/sns/index.md | 43 +++ .../providers/awscc/sns/topic/index.md | 102 ++++++ .../awscc/sns/topic_inline_policies/index.md | 55 ++++ .../awscc/sns/topic_inline_policy/index.md | 67 ++++ .../awscc/sns/topic_policies/index.md | 54 ++++ .../providers/awscc/sns/topic_policy/index.md | 63 ++++ .../providers/awscc/sns/topics/index.md | 64 ++++ docs/awscc-docs/providers/awscc/sqs/index.md | 43 +++ .../providers/awscc/sqs/queue/index.md | 103 ++++++ .../awscc/sqs/queue_inline_policies/index.md | 56 ++++ .../awscc/sqs/queue_inline_policy/index.md | 69 ++++ .../awscc/sqs/queue_policies/index.md | 54 ++++ .../providers/awscc/sqs/queue_policy/index.md | 63 ++++ .../providers/awscc/sqs/queues/index.md | 62 ++++ .../providers/awscc/ssm/association/index.md | 102 ++++++ .../providers/awscc/ssm/associations/index.md | 63 ++++ .../providers/awscc/ssm/document/index.md | 90 ++++++ .../providers/awscc/ssm/documents/index.md | 63 ++++ docs/awscc-docs/providers/awscc/ssm/index.md | 49 +++ .../providers/awscc/ssm/parameter/index.md | 82 +++++ .../providers/awscc/ssm/parameters/index.md | 60 ++++ .../awscc/ssm/patch_baseline/index.md | 101 ++++++ .../awscc/ssm/patch_baselines/index.md | 67 ++++ .../awscc/ssm/resource_data_sync/index.md | 81 +++++ .../awscc/ssm/resource_data_syncs/index.md | 59 ++++ .../awscc/ssm/resource_policies/index.md | 60 ++++ .../awscc/ssm/resource_policy/index.md | 70 ++++ .../awscc/ssmcontacts/contact/index.md | 75 +++++ .../ssmcontacts/contact_channel/index.md | 75 +++++ .../ssmcontacts/contact_channels/index.md | 59 ++++ .../awscc/ssmcontacts/contacts/index.md | 60 ++++ .../providers/awscc/ssmcontacts/index.md | 45 +++ .../providers/awscc/ssmcontacts/plan/index.md | 73 +++++ .../awscc/ssmcontacts/plans/index.md | 56 ++++ .../awscc/ssmcontacts/rotation/index.md | 85 +++++ .../awscc/ssmcontacts/rotations/index.md | 64 ++++ .../providers/awscc/ssmincidents/index.md | 41 +++ .../ssmincidents/replication_set/index.md | 77 +++++ .../ssmincidents/replication_sets/index.md | 64 ++++ .../awscc/ssmincidents/response_plan/index.md | 89 ++++++ .../ssmincidents/response_plans/index.md | 65 ++++ .../providers/awscc/sso/assignment/index.md | 80 +++++ .../providers/awscc/sso/assignments/index.md | 77 +++++ docs/awscc-docs/providers/awscc/sso/index.md | 43 +++ .../index.md | 69 ++++ .../index.md | 60 ++++ .../awscc/sso/permission_set/index.md | 107 +++++++ .../awscc/sso/permission_sets/index.md | 71 ++++ .../awscc/stepfunctions/activities/index.md | 54 ++++ .../awscc/stepfunctions/activity/index.md | 70 ++++ .../providers/awscc/stepfunctions/index.md | 45 +++ .../stepfunctions/state_machine/index.md | 93 ++++++ .../state_machine_alias/index.md | 74 +++++ .../state_machine_aliases/index.md | 59 ++++ .../state_machine_version/index.md | 66 ++++ .../state_machine_versions/index.md | 60 ++++ .../stepfunctions/state_machines/index.md | 62 ++++ .../awscc/supportapp/account_alias/index.md | 67 ++++ .../awscc/supportapp/account_aliases/index.md | 59 ++++ .../providers/awscc/supportapp/index.md | 43 +++ .../slack_channel_configuration/index.md | 80 +++++ .../slack_channel_configurations/index.md | 61 ++++ .../slack_workspace_configuration/index.md | 67 ++++ .../slack_workspace_configurations/index.md | 59 ++++ .../awscc/synthetics/canaries/index.md | 79 +++++ .../awscc/synthetics/canary/index.md | 119 +++++++ .../providers/awscc/synthetics/group/index.md | 77 +++++ .../awscc/synthetics/groups/index.md | 61 ++++ .../providers/awscc/synthetics/index.md | 41 +++ .../systemsmanagersap/application/index.md | 82 +++++ .../systemsmanagersap/applications/index.md | 61 ++++ .../awscc/systemsmanagersap/index.md | 39 +++ .../awscc/timestream/database/index.md | 76 +++++ .../awscc/timestream/databases/index.md | 64 ++++ .../providers/awscc/timestream/index.md | 43 +++ .../timestream/scheduled_queries/index.md | 60 ++++ .../awscc/timestream/scheduled_query/index.md | 105 ++++++ .../providers/awscc/timestream/table/index.md | 91 ++++++ .../awscc/timestream/tables/index.md | 69 ++++ .../awscc/transfer/agreement/index.md | 85 +++++ .../awscc/transfer/agreements/index.md | 62 ++++ .../awscc/transfer/certificate/index.md | 93 ++++++ .../awscc/transfer/certificates/index.md | 59 ++++ .../awscc/transfer/connector/index.md | 80 +++++ .../awscc/transfer/connectors/index.md | 60 ++++ .../providers/awscc/transfer/index.md | 47 +++ .../providers/awscc/transfer/profile/index.md | 75 +++++ .../awscc/transfer/profiles/index.md | 59 ++++ .../awscc/transfer/workflow/index.md | 74 +++++ .../awscc/transfer/workflows/index.md | 59 ++++ .../identity_source/index.md | 90 ++++++ .../identity_sources/index.md | 72 +++++ .../awscc/verifiedpermissions/index.md | 45 +++ .../verifiedpermissions/policies/index.md | 66 ++++ .../awscc/verifiedpermissions/policy/index.md | 79 +++++ .../verifiedpermissions/policy_store/index.md | 83 +++++ .../policy_stores/index.md | 67 ++++ .../policy_template/index.md | 79 +++++ .../policy_templates/index.md | 67 ++++ .../providers/awscc/voiceid/domain/index.md | 82 +++++ .../providers/awscc/voiceid/domains/index.md | 65 ++++ .../providers/awscc/voiceid/index.md | 39 +++ .../access_log_subscription/index.md | 107 +++++++ .../access_log_subscriptions/index.md | 77 +++++ .../awscc/vpclattice/auth_policies/index.md | 55 ++++ .../awscc/vpclattice/auth_policy/index.md | 69 ++++ .../providers/awscc/vpclattice/index.md | 57 ++++ .../awscc/vpclattice/listener/index.md | 86 +++++ .../awscc/vpclattice/listeners/index.md | 61 ++++ .../vpclattice/resource_policies/index.md | 55 ++++ .../awscc/vpclattice/resource_policy/index.md | 67 ++++ .../providers/awscc/vpclattice/rule/index.md | 83 +++++ .../providers/awscc/vpclattice/rules/index.md | 61 ++++ .../awscc/vpclattice/service/index.md | 89 ++++++ .../awscc/vpclattice/service_network/index.md | 79 +++++ .../index.md | 94 ++++++ .../index.md | 61 ++++ .../service_network_vpc_association/index.md | 92 ++++++ .../service_network_vpc_associations/index.md | 64 ++++ .../vpclattice/service_networks/index.md | 62 ++++ .../awscc/vpclattice/services/index.md | 64 ++++ .../awscc/vpclattice/target_group/index.md | 102 ++++++ .../awscc/vpclattice/target_groups/index.md | 72 +++++ .../awscc-docs/providers/awscc/wafv2/index.md | 49 +++ .../providers/awscc/wafv2/ip_set/index.md | 82 +++++ .../providers/awscc/wafv2/ip_sets/index.md | 64 ++++ .../wafv2/logging_configuration/index.md | 82 +++++ .../wafv2/logging_configurations/index.md | 68 ++++ .../awscc/wafv2/regex_pattern_set/index.md | 80 +++++ .../awscc/wafv2/regex_pattern_sets/index.md | 64 ++++ .../providers/awscc/wafv2/rule_group/index.md | 92 ++++++ .../awscc/wafv2/rule_groups/index.md | 64 ++++ .../providers/awscc/wafv2/web_acl/index.md | 98 ++++++ .../providers/awscc/wafv2/web_acls/index.md | 64 ++++ .../awscc/wafv2/webacl_association/index.md | 113 +++++++ .../awscc/wafv2/webacl_associations/index.md | 72 +++++ .../providers/awscc/wisdom/assistant/index.md | 75 +++++ .../wisdom/assistant_association/index.md | 76 +++++ .../wisdom/assistant_associations/index.md | 61 ++++ .../awscc/wisdom/assistants/index.md | 61 ++++ .../providers/awscc/wisdom/index.md | 43 +++ .../awscc/wisdom/knowledge_base/index.md | 82 +++++ .../awscc/wisdom/knowledge_bases/index.md | 69 ++++ .../workspaces/connection_alias/index.md | 67 ++++ .../workspaces/connection_aliases/index.md | 54 ++++ .../providers/awscc/workspaces/index.md | 39 +++ .../workspacesthinclient/environment/index.md | 119 +++++++ .../environments/index.md | 72 +++++ .../awscc/workspacesthinclient/index.md | 39 +++ .../workspacesweb/browser_settings/index.md | 93 ++++++ .../workspacesweb/identity_provider/index.md | 79 +++++ .../workspacesweb/identity_providers/index.md | 61 ++++ .../providers/awscc/workspacesweb/index.md | 48 +++ .../workspacesweb/ip_access_settings/index.md | 100 ++++++ .../workspacesweb/network_settings/index.md | 80 +++++ .../awscc/workspacesweb/portal/index.md | 145 +++++++++ .../awscc/workspacesweb/portals/index.md | 82 +++++ .../awscc/workspacesweb/trust_store/index.md | 80 +++++ .../awscc/workspacesweb/trust_stores/index.md | 64 ++++ .../user_access_logging_settings/index.md | 77 +++++ .../workspacesweb/user_settings/index.md | 105 ++++++ .../providers/awscc/xray/group/index.md | 75 +++++ .../providers/awscc/xray/groups/index.md | 60 ++++ docs/awscc-docs/providers/awscc/xray/index.md | 43 +++ .../awscc/xray/resource_policies/index.md | 59 ++++ .../awscc/xray/resource_policy/index.md | 68 ++++ .../awscc/xray/sampling_rule/index.md | 77 +++++ .../awscc/xray/sampling_rules/index.md | 60 ++++ docs/awscc-docs/stackql-provider-registry.mdx | 20 ++ package.json | 2 + scripts/docgen/provider_data.py | 1 + sidebars.js | 1 + src/configs/providers.ts | 1 + 1915 files changed, 135147 insertions(+), 1 deletion(-) create mode 100644 docs/awscc-docs/index.md create mode 100644 docs/awscc-docs/providers/awscc/accessanalyzer/analyzer/index.md create mode 100644 docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md create mode 100644 docs/awscc-docs/providers/awscc/accessanalyzer/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activation/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activations/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/permission/index.md create mode 100644 docs/awscc-docs/providers/awscc/acmpca/permissions/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplify/app/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplify/apps/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplify/branch/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplify/branches/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplify/domain/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplify/domains/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplify/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/component/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/theme/index.md create mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/account/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/accounts/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/api_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/base_path_mapping/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/base_path_mappings/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/deployment/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/deployments/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/gateway_response/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/method/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/methods/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/model/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/models/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/resource/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/resources/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/stage/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/stages/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plan_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plan_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/integration_response/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md create mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/extension/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/extensions/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/appconfig/index.md create mode 100644 docs/awscc-docs/providers/awscc/appflow/connector/index.md create mode 100644 docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/appflow/connectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/appflow/flow/index.md create mode 100644 docs/awscc-docs/providers/awscc/appflow/flows/index.md create mode 100644 docs/awscc-docs/providers/awscc/appflow/index.md create mode 100644 docs/awscc-docs/providers/awscc/appintegrations/data_integration/index.md create mode 100644 docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md create mode 100644 docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/appintegrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_target/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationinsights/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/applicationinsights/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/observability_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/service/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/services/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connection/index.md create mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connections/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/app_block/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/app_block_builder/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/app_block_builders/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/app_blocks/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/application_entitlement_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/application_entitlement_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/application_fleet_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/application_fleet_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/directory_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/entitlement/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/entitlements/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/image_builder/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/image_builders/index.md create mode 100644 docs/awscc-docs/providers/awscc/appstream/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/domain_name/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/domain_name_api_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/domain_name_api_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/domain_names/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/resolver/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/resolvers/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/source_api_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/appsync/source_api_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/aps/index.md create mode 100644 docs/awscc-docs/providers/awscc/aps/rule_groups_namespace/index.md create mode 100644 docs/awscc-docs/providers/awscc/aps/rule_groups_namespaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/aps/workspace/index.md create mode 100644 docs/awscc-docs/providers/awscc/aps/workspaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/arczonalshift/index.md create mode 100644 docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/data_catalog/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/named_queries/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/named_query/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/work_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/athena/work_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md create mode 100644 docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md create mode 100644 docs/awscc-docs/providers/awscc/auditmanager/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/launch_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md create mode 100644 docs/awscc-docs/providers/awscc/autoscaling/warm_pools/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/capability/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/partnership/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/transformer/index.md create mode 100644 docs/awscc-docs/providers/awscc/b2bi/transformers/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/backup_plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/backup_plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/backup_selection/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/backup_selections/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/backup_vault/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/framework/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/frameworks/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/report_plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/report_plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_selection/index.md create mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_selections/index.md create mode 100644 docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md create mode 100644 docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md create mode 100644 docs/awscc-docs/providers/awscc/backupgateway/index.md create mode 100644 docs/awscc-docs/providers/awscc/batch/compute_environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/batch/compute_environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/batch/index.md create mode 100644 docs/awscc-docs/providers/awscc/batch/job_queue/index.md create mode 100644 docs/awscc-docs/providers/awscc/batch/job_queues/index.md create mode 100644 docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/custom_line_item/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/custom_line_items/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md create mode 100644 docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md create mode 100644 docs/awscc-docs/providers/awscc/budgets/index.md create mode 100644 docs/awscc-docs/providers/awscc/cassandra/index.md create mode 100644 docs/awscc-docs/providers/awscc/cassandra/keyspace/index.md create mode 100644 docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/cassandra/table/index.md create mode 100644 docs/awscc-docs/providers/awscc/cassandra/tables/index.md create mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md create mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md create mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md create mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md create mode 100644 docs/awscc-docs/providers/awscc/ce/cost_categories/index.md create mode 100644 docs/awscc-docs/providers/awscc/ce/cost_category/index.md create mode 100644 docs/awscc-docs/providers/awscc/ce/index.md create mode 100644 docs/awscc-docs/providers/awscc/certificatemanager/account/index.md create mode 100644 docs/awscc-docs/providers/awscc/certificatemanager/accounts/index.md create mode 100644 docs/awscc-docs/providers/awscc/certificatemanager/index.md create mode 100644 docs/awscc-docs/providers/awscc/chatbot/index.md create mode 100644 docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/chatbot/slack_channel_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/chatbot/slack_channel_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_table_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_table_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/membership/index.md create mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloud_control/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resource/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resource_request/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resource_requests/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resources/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_default_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_default_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_type_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_type_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/module_default_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/module_default_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/module_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/public_type_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/public_type_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_default_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_default_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stack/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identities/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identity/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/function/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/functions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_value_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_value_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscriptions/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_access_control/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_access_controls/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_request_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_request_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/realtime_log_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/realtime_log_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/response_headers_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudfront/response_headers_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/event_data_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/event_data_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/resource_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/metric_stream/index.md create mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeartifact/domain/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeartifact/domains/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeartifact/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeartifact/repositories/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeartifact/repository/index.md create mode 100644 docs/awscc-docs/providers/awscc/codebuild/fleet/index.md create mode 100644 docs/awscc-docs/providers/awscc/codebuild/fleets/index.md create mode 100644 docs/awscc-docs/providers/awscc/codebuild/index.md create mode 100644 docs/awscc-docs/providers/awscc/codedeploy/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/codedeploy/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/codedeploy/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeguruprofiler/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/codegurureviewer/index.md create mode 100644 docs/awscc-docs/providers/awscc/codegurureviewer/repository_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/codepipeline/custom_action_type/index.md create mode 100644 docs/awscc-docs/providers/awscc/codepipeline/custom_action_types/index.md create mode 100644 docs/awscc-docs/providers/awscc/codepipeline/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/connection/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/repository_link/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarnotifications/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarnotifications/notification_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tag/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tags/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachment/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachments/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/log_delivery_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/log_delivery_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_client/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_clients/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachment/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachments/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_user/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachment/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachments/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_users/index.md create mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pools/index.md create mode 100644 docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md create mode 100644 docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md create mode 100644 docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md create mode 100644 docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md create mode 100644 docs/awscc-docs/providers/awscc/comprehend/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/aggregation_authorization/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/config_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/config_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/conformance_pack/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/conformance_packs/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/organization_conformance_pack/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/organization_conformance_packs/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/stored_queries/index.md create mode 100644 docs/awscc-docs/providers/awscc/config/stored_query/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/approved_origin/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/approved_origins/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flow/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flow_module/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flow_modules/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flows/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/hours_of_operation/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/hours_of_operations/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/instance/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/instance_storage_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/instance_storage_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/instances/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/integration_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/integration_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/prompt/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/prompts/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/queue/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/queues/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/quick_connect/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/quick_connects/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/routing_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/security_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/security_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/security_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/security_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/task_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/task_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/traffic_distribution_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/traffic_distribution_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/user/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/user_hierarchy_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/user_hierarchy_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/users/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/view/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/view_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/view_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/connect/views/index.md create mode 100644 docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md create mode 100644 docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md create mode 100644 docs/awscc-docs/providers/awscc/connectcampaigns/index.md create mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_baseline/index.md create mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md create mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md create mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md create mode 100644 docs/awscc-docs/providers/awscc/controltower/index.md create mode 100644 docs/awscc-docs/providers/awscc/controltower/landing_zone/index.md create mode 100644 docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md create mode 100644 docs/awscc-docs/providers/awscc/cur/index.md create mode 100644 docs/awscc-docs/providers/awscc/cur/report_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/cur/report_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/integration/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md create mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/dataset/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/datasets/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/job/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/jobs/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/project/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/recipe/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/recipes/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/ruleset/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/rulesets/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/schedule/index.md create mode 100644 docs/awscc-docs/providers/awscc/databrew/schedules/index.md create mode 100644 docs/awscc-docs/providers/awscc/datapipeline/index.md create mode 100644 docs/awscc-docs/providers/awscc/datapipeline/pipeline/index.md create mode 100644 docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/agent/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/agents/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_azure_blob/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_azure_blobs/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_efs/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_object_storage/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_object_storages/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_s3/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_smb/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustre/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustres/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontap/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontaps/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_open_zfs/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_windows/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/storage_system/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/task/index.md create mode 100644 docs/awscc-docs/providers/awscc/datasync/tasks/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/data_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/data_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/domain/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/domains/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/project/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md create mode 100644 docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md create mode 100644 docs/awscc-docs/providers/awscc/detective/graph/index.md create mode 100644 docs/awscc-docs/providers/awscc/detective/graphs/index.md create mode 100644 docs/awscc-docs/providers/awscc/detective/index.md create mode 100644 docs/awscc-docs/providers/awscc/detective/member_invitation/index.md create mode 100644 docs/awscc-docs/providers/awscc/detective/member_invitations/index.md create mode 100644 docs/awscc-docs/providers/awscc/detective/organization_admin/index.md create mode 100644 docs/awscc-docs/providers/awscc/detective/organization_admins/index.md create mode 100644 docs/awscc-docs/providers/awscc/devopsguru/index.md create mode 100644 docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integration/index.md create mode 100644 docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md create mode 100644 docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md create mode 100644 docs/awscc-docs/providers/awscc/directoryservice/index.md create mode 100644 docs/awscc-docs/providers/awscc/directoryservice/simple_ad/index.md create mode 100644 docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/data_provider/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/data_providers/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/instance_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/migration_project/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/migration_projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/replication_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/dms/replication_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/docdbelastic/index.md create mode 100644 docs/awscc-docs/providers/awscc/dynamodb/global_table/index.md create mode 100644 docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md create mode 100644 docs/awscc-docs/providers/awscc/dynamodb/index.md create mode 100644 docs/awscc-docs/providers/awscc/dynamodb/table/index.md create mode 100644 docs/awscc-docs/providers/awscc/dynamodb/tables/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/public_repositories/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/public_repository/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/repositories/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecr/repository/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/cluster_capacity_provider_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/primary_task_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/primary_task_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/service/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/services/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/task_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/task_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/ecs/task_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/efs/access_point/index.md create mode 100644 docs/awscc-docs/providers/awscc/efs/access_points/index.md create mode 100644 docs/awscc-docs/providers/awscc/efs/file_system/index.md create mode 100644 docs/awscc-docs/providers/awscc/efs/file_systems/index.md create mode 100644 docs/awscc-docs/providers/awscc/efs/index.md create mode 100644 docs/awscc-docs/providers/awscc/efs/mount_target/index.md create mode 100644 docs/awscc-docs/providers/awscc/efs/mount_targets/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/access_entries/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/access_entry/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/addon/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/addons/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/identity_provider_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/identity_provider_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/nodegroup/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/nodegroups/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/pod_identity_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/eks/pod_identity_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/global_replication_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/global_replication_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/serverless_cache/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/user/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/user_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticache/users/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocation/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocations/index.md create mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/security_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/security_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/step/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/steps/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/studio/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/studio_session_mapping/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/studio_session_mappings/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/studios/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md create mode 100644 docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/emrcontainers/index.md create mode 100644 docs/awscc-docs/providers/awscc/emrcontainers/virtual_cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/emrserverless/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/emrserverless/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/emrserverless/index.md create mode 100644 docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflow/index.md create mode 100644 docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflows/index.md create mode 100644 docs/awscc-docs/providers/awscc/entityresolution/index.md create mode 100644 docs/awscc-docs/providers/awscc/entityresolution/matching_workflow/index.md create mode 100644 docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md create mode 100644 docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md create mode 100644 docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/api_destination/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/api_destinations/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/archive/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/archives/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/connection/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/connections/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/endpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/endpoints/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/event_bus/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/event_buses/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/events/rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/registries/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/registry_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/schema/index.md create mode 100644 docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/experiment/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/experiments/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/feature/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/features/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/launch/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/launches/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/project/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/segment/index.md create mode 100644 docs/awscc-docs/providers/awscc/evidently/segments/index.md create mode 100644 docs/awscc-docs/providers/awscc/finspace/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/finspace/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/finspace/index.md create mode 100644 docs/awscc-docs/providers/awscc/fis/experiment_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/fis/index.md create mode 100644 docs/awscc-docs/providers/awscc/fis/target_account_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/fis/target_account_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/fms/index.md create mode 100644 docs/awscc-docs/providers/awscc/fms/notification_channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/fms/notification_channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/fms/policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/fms/policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/fms/resource_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/fms/resource_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/forecast/dataset/index.md create mode 100644 docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/forecast/datasets/index.md create mode 100644 docs/awscc-docs/providers/awscc/forecast/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/detector/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/label/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/labels/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/lists/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/variable/index.md create mode 100644 docs/awscc-docs/providers/awscc/frauddetector/variables/index.md create mode 100644 docs/awscc-docs/providers/awscc/fsx/data_repository_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/fsx/data_repository_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/fsx/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/alias/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/aliases/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/build/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/builds/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/fleet/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/fleets/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_server_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_server_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_session_queue/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_session_queues/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/location/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/locations/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/script/index.md create mode 100644 docs/awscc-docs/providers/awscc/gamelift/scripts/index.md create mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md create mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md create mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/index.md create mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/listener/index.md create mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md create mode 100644 docs/awscc-docs/providers/awscc/glue/index.md create mode 100644 docs/awscc-docs/providers/awscc/glue/schema_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/glue/schema_version_metadata/index.md create mode 100644 docs/awscc-docs/providers/awscc/glue/schema_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/grafana/index.md create mode 100644 docs/awscc-docs/providers/awscc/grafana/workspace/index.md create mode 100644 docs/awscc-docs/providers/awscc/grafana/workspaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md create mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md create mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/index.md create mode 100644 docs/awscc-docs/providers/awscc/groundstation/config/index.md create mode 100644 docs/awscc-docs/providers/awscc/groundstation/configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/groundstation/index.md create mode 100644 docs/awscc-docs/providers/awscc/groundstation/mission_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/detector/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/detectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/filter/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/filters/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/ip_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/master/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/masters/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/member/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/members/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/threat_intel_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/guardduty/threat_intel_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md create mode 100644 docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md create mode 100644 docs/awscc-docs/providers/awscc/healthimaging/index.md create mode 100644 docs/awscc-docs/providers/awscc/healthlake/fhir_datastore/index.md create mode 100644 docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md create mode 100644 docs/awscc-docs/providers/awscc/healthlake/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/group/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/group_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/group_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/instance_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/managed_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/managed_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/role/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/role_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/role_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/roles/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/saml_provider/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/saml_providers/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/server_certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/server_certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/service_linked_role/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/service_linked_roles/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/user/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/user_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/user_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/users/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md create mode 100644 docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md create mode 100644 docs/awscc-docs/providers/awscc/identitystore/group/index.md create mode 100644 docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md create mode 100644 docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md create mode 100644 docs/awscc-docs/providers/awscc/identitystore/groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/identitystore/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/component/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/components/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/images/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md create mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspector/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspector/resource_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspector/resource_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md create mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/index.md create mode 100644 docs/awscc-docs/providers/awscc/internetmonitor/index.md create mode 100644 docs/awscc-docs/providers/awscc/internetmonitor/monitor/index.md create mode 100644 docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/account_audit_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/account_audit_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/authorizer/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/authorizers/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/billing_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/billing_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/custom_metric/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/dimension/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/dimensions/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/job_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/job_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/logging/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/loggings/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/resource_specific_logging/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/resource_specific_loggings/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/role_alias/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/role_aliases/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/security_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/security_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/software_package/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/software_package_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/software_package_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/software_packages/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/thing/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/thing_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/thing_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/thing_type/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/thing_types/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/things/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rule_destination/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rule_destinations/index.md create mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/pipeline/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotevents/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotevents/input/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotevents/inputs/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleethub/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleethub/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/campaign/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/model_manifest/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/portal/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/project/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/scene/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md create mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/destination/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/multicast_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_task/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_tasks/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md create mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/playback_key_pair/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/playback_key_pairs/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/stage/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/stages/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/stream_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivschat/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivschat/logging_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivschat/room/index.md create mode 100644 docs/awscc-docs/providers/awscc/ivschat/rooms/index.md create mode 100644 docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md create mode 100644 docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/kafkaconnect/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendra/data_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendra/data_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendra/faq/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendra/faqs/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendra/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendra/index/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendra/indices/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/kendraranking/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesis/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesis/kinesis_stream/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesis/streams/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_stream/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisfirehose/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/kinesisvideo_stream/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/streams/index.md create mode 100644 docs/awscc-docs/providers/awscc/kms/alias/index.md create mode 100644 docs/awscc-docs/providers/awscc/kms/aliases/index.md create mode 100644 docs/awscc-docs/providers/awscc/kms/index.md create mode 100644 docs/awscc-docs/providers/awscc/kms/key/index.md create mode 100644 docs/awscc-docs/providers/awscc/kms/keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/kms/replica_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/kms/replica_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/data_cells_filter/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/data_cells_filters/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/principal_permissions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/tag/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/tag_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/lakeformation/tags/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/code_signing_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/code_signing_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/event_invoke_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/event_invoke_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/event_source_mapping/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/event_source_mappings/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/function/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/functions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_version_permission/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_version_permissions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/permission/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/permissions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/url/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/urls/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/version/index.md create mode 100644 docs/awscc-docs/providers/awscc/lambda/versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/bot/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/bot_alias/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/bot_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/bot_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/bots/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/resource_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/lex/resource_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/licensemanager/grant/index.md create mode 100644 docs/awscc-docs/providers/awscc/licensemanager/grants/index.md create mode 100644 docs/awscc-docs/providers/awscc/licensemanager/index.md create mode 100644 docs/awscc-docs/providers/awscc/licensemanager/license/index.md create mode 100644 docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/alarm/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/alarms/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/bucket/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/buckets/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/container/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/containers/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/database/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/databases/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/distribution/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/distributions/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/instance/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/instances/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md create mode 100644 docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/api_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/api_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/geofence_collection/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/geofence_collections/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/map/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/maps/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/place_index/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/place_indices/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/route_calculator/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/route_calculators/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/tracker/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md create mode 100644 docs/awscc-docs/providers/awscc/location/trackers/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/account_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/account_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/deliveries/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/delivery/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/destination/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/destinations/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/log_anomaly_detector/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/log_anomaly_detectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/log_stream/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/log_streams/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/metric_filter/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/metric_filters/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/query_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/query_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/resource_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/resource_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md create mode 100644 docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutequipment/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutequipment/inference_scheduler/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutvision/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutvision/project/index.md create mode 100644 docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/m2/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/m2/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/m2/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/m2/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/m2/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/allow_list/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/allow_lists/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/custom_data_identifier/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/custom_data_identifiers/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/findings_filter/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/findings_filters/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/session/index.md create mode 100644 docs/awscc-docs/providers/awscc/macie/sessions/index.md create mode 100644 docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md create mode 100644 docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md create mode 100644 docs/awscc-docs/providers/awscc/managedblockchain/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge_outputs/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interface/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interfaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/index.md create mode 100644 docs/awscc-docs/providers/awscc/medialive/index.md create mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplex/index.md create mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md create mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md create mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/asset/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/assets/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/origin_endpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/channel_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/live_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/acl/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/acls/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/parameter_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/user/index.md create mode 100644 docs/awscc-docs/providers/awscc/memorydb/users/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/batch_scram_secret/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/batch_scram_secrets/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/replicator/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/replicators/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md create mode 100644 docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md create mode 100644 docs/awscc-docs/providers/awscc/mwaa/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/mwaa/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/mwaa/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptune/db_cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptune/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/graph/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoints/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/logging_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/device/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/devices/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/link/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/links/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/site/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachment/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachments/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/sites/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peering/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peerings/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registration/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachment/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachments/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md create mode 100644 docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/launch_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md create mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md create mode 100644 docs/awscc-docs/providers/awscc/oam/index.md create mode 100644 docs/awscc-docs/providers/awscc/oam/link/index.md create mode 100644 docs/awscc-docs/providers/awscc/oam/links/index.md create mode 100644 docs/awscc-docs/providers/awscc/oam/sink/index.md create mode 100644 docs/awscc-docs/providers/awscc/oam/sinks/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/annotation_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/reference_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/reference_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/run_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/run_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/sequence_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/variant_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/variant_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/workflow/index.md create mode 100644 docs/awscc-docs/providers/awscc/omics/workflows/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchservice/domains/index.md create mode 100644 docs/awscc-docs/providers/awscc/opensearchservice/index.md create mode 100644 docs/awscc-docs/providers/awscc/opsworkscm/index.md create mode 100644 docs/awscc-docs/providers/awscc/opsworkscm/server/index.md create mode 100644 docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/account/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/accounts/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/organization/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/organizations/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/osis/index.md create mode 100644 docs/awscc-docs/providers/awscc/osis/pipeline/index.md create mode 100644 docs/awscc-docs/providers/awscc/osis/pipelines/index.md create mode 100644 docs/awscc-docs/providers/awscc/panorama/application_instance/index.md create mode 100644 docs/awscc-docs/providers/awscc/panorama/application_instances/index.md create mode 100644 docs/awscc-docs/providers/awscc/panorama/index.md create mode 100644 docs/awscc-docs/providers/awscc/panorama/package/index.md create mode 100644 docs/awscc-docs/providers/awscc/panorama/package_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/panorama/package_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/panorama/packages/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_name/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_names/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entries/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entry/index.md create mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/dataset/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/datasets/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/schema/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/schemata/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/solution/index.md create mode 100644 docs/awscc-docs/providers/awscc/personalize/solutions/index.md create mode 100644 docs/awscc-docs/providers/awscc/pinpoint/in_app_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/pinpoint/in_app_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/pinpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/pipes/index.md create mode 100644 docs/awscc-docs/providers/awscc/pipes/pipe/index.md create mode 100644 docs/awscc-docs/providers/awscc/pipes/pipes/index.md create mode 100644 docs/awscc-docs/providers/awscc/proton/environment_account_connection/index.md create mode 100644 docs/awscc-docs/providers/awscc/proton/environment_account_connections/index.md create mode 100644 docs/awscc-docs/providers/awscc/proton/environment_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/proton/environment_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/proton/index.md create mode 100644 docs/awscc-docs/providers/awscc/proton/service_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/proton/service_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/qldb/index.md create mode 100644 docs/awscc-docs/providers/awscc/qldb/qldb_stream/index.md create mode 100644 docs/awscc-docs/providers/awscc/qldb/streams/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/analyses/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/analysis/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/refresh_schedule/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/template/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/theme/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/themes/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/topic/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/topics/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md create mode 100644 docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md create mode 100644 docs/awscc-docs/providers/awscc/ram/index.md create mode 100644 docs/awscc-docs/providers/awscc/ram/permission/index.md create mode 100644 docs/awscc-docs/providers/awscc/ram/permissions/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/customdb_engine_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/customdb_engine_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_instance/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_instances/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_parameter_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_parameter_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxies/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_endpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_endpoints/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_target_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_target_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_subnet_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/db_subnet_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/event_subscription/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/global_cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/global_clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/integration/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/integrations/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/option_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/rds/option_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_parameter_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_parameter_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_subnet_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_subnet_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/scheduled_action/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/namespace/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md create mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/route/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/service/index.md create mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/services/index.md create mode 100644 docs/awscc-docs/providers/awscc/rekognition/collection/index.md create mode 100644 docs/awscc-docs/providers/awscc/rekognition/collections/index.md create mode 100644 docs/awscc-docs/providers/awscc/rekognition/index.md create mode 100644 docs/awscc-docs/providers/awscc/rekognition/project/index.md create mode 100644 docs/awscc-docs/providers/awscc/rekognition/projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md create mode 100644 docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md create mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/app/index.md create mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md create mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/index.md create mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/index/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourcegroups/group/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/resourcegroups/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/fleet/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/fleets/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot_application_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot_application_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/robots/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/simulation_application_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/simulation_application_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md create mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md create mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/index.md create mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md create mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/dnssec/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/dnssecs/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/health_check/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/health_checks/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/key_signing_key/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53/key_signing_keys/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_control/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_check/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_list/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_lists/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/outpost_resolver/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/rum/app_monitor/index.md create mode 100644 docs/awscc-docs/providers/awscc/rum/app_monitors/index.md create mode 100644 docs/awscc-docs/providers/awscc/rum/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_grant/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_instance/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_instances/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_location/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_locations/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_point/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/access_points/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/bucket/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/buckets/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_point/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_points/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/storage_lens/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/storage_lens_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3/storage_lens_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3express/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/access_point/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/access_point/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/bucket_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md create mode 100644 docs/awscc-docs/providers/awscc/s3outposts/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/app/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/app_image_config/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/app_image_configs/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/apps/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/device/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/device_fleets/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/devices/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/image/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/images/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_component/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_package_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_package_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definition/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definitions/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/project/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/projects/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/space/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/scheduler/index.md create mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedule/index.md create mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedules/index.md create mode 100644 docs/awscc-docs/providers/awscc/secretsmanager/index.md create mode 100644 docs/awscc-docs/providers/awscc/secretsmanager/secret/index.md create mode 100644 docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md create mode 100644 docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/securityhub/hub/index.md create mode 100644 docs/awscc-docs/providers/awscc/securityhub/hubs/index.md create mode 100644 docs/awscc-docs/providers/awscc/securityhub/index.md create mode 100644 docs/awscc-docs/providers/awscc/securityhub/standard/index.md create mode 100644 docs/awscc-docs/providers/awscc/securityhub/standards/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_product/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_products/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_action/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_action_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_action_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/configuration_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/configuration_set_event_destination/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/configuration_set_event_destinations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/contact_list/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/contact_lists/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/dedicated_ip_pool/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/dedicated_ip_pools/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/email_identities/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/email_identity/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/template/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/drt_access/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/proactive_engagement/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/protection/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/protection_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/protection_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/shield/protections/index.md create mode 100644 docs/awscc-docs/providers/awscc/signer/index.md create mode 100644 docs/awscc-docs/providers/awscc/signer/profile_permission/index.md create mode 100644 docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md create mode 100644 docs/awscc-docs/providers/awscc/signer/signing_profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/simspaceweaver/index.md create mode 100644 docs/awscc-docs/providers/awscc/simspaceweaver/simulation/index.md create mode 100644 docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md create mode 100644 docs/awscc-docs/providers/awscc/sns/index.md create mode 100644 docs/awscc-docs/providers/awscc/sns/topic/index.md create mode 100644 docs/awscc-docs/providers/awscc/sns/topic_inline_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/sns/topic_inline_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/sns/topic_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/sns/topic_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/sns/topics/index.md create mode 100644 docs/awscc-docs/providers/awscc/sqs/index.md create mode 100644 docs/awscc-docs/providers/awscc/sqs/queue/index.md create mode 100644 docs/awscc-docs/providers/awscc/sqs/queue_inline_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/sqs/queue_inline_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/sqs/queue_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/sqs/queue_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/sqs/queues/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/association/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/document/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/documents/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/parameter/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/parameters/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_data_sync/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_data_syncs/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/replication_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md create mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md create mode 100644 docs/awscc-docs/providers/awscc/sso/assignment/index.md create mode 100644 docs/awscc-docs/providers/awscc/sso/assignments/index.md create mode 100644 docs/awscc-docs/providers/awscc/sso/index.md create mode 100644 docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/sso/permission_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/sso/permission_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/activities/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_alias/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_aliases/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_version/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_versions/index.md create mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md create mode 100644 docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md create mode 100644 docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md create mode 100644 docs/awscc-docs/providers/awscc/supportapp/index.md create mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_channel_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_channel_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/synthetics/canaries/index.md create mode 100644 docs/awscc-docs/providers/awscc/synthetics/canary/index.md create mode 100644 docs/awscc-docs/providers/awscc/synthetics/group/index.md create mode 100644 docs/awscc-docs/providers/awscc/synthetics/groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/synthetics/index.md create mode 100644 docs/awscc-docs/providers/awscc/systemsmanagersap/application/index.md create mode 100644 docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md create mode 100644 docs/awscc-docs/providers/awscc/systemsmanagersap/index.md create mode 100644 docs/awscc-docs/providers/awscc/timestream/database/index.md create mode 100644 docs/awscc-docs/providers/awscc/timestream/databases/index.md create mode 100644 docs/awscc-docs/providers/awscc/timestream/index.md create mode 100644 docs/awscc-docs/providers/awscc/timestream/scheduled_queries/index.md create mode 100644 docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md create mode 100644 docs/awscc-docs/providers/awscc/timestream/table/index.md create mode 100644 docs/awscc-docs/providers/awscc/timestream/tables/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/agreement/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/agreements/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/certificate/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/certificates/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/connector/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/connectors/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/profile/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/profiles/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/workflow/index.md create mode 100644 docs/awscc-docs/providers/awscc/transfer/workflows/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md create mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md create mode 100644 docs/awscc-docs/providers/awscc/voiceid/domain/index.md create mode 100644 docs/awscc-docs/providers/awscc/voiceid/domains/index.md create mode 100644 docs/awscc-docs/providers/awscc/voiceid/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/access_log_subscription/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/access_log_subscriptions/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/auth_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/listener/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/resource_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/rules/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_service_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_service_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/services/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/ip_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/regex_pattern_set/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/regex_pattern_sets/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/wafv2/webacl_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistant/index.md create mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md create mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md create mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistants/index.md create mode 100644 docs/awscc-docs/providers/awscc/wisdom/index.md create mode 100644 docs/awscc-docs/providers/awscc/wisdom/knowledge_base/index.md create mode 100644 docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspaces/connection_aliases/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspaces/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesthinclient/environment/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesthinclient/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/browser_settings/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/ip_access_settings/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/user_access_logging_settings/index.md create mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md create mode 100644 docs/awscc-docs/providers/awscc/xray/group/index.md create mode 100644 docs/awscc-docs/providers/awscc/xray/groups/index.md create mode 100644 docs/awscc-docs/providers/awscc/xray/index.md create mode 100644 docs/awscc-docs/providers/awscc/xray/resource_policies/index.md create mode 100644 docs/awscc-docs/providers/awscc/xray/resource_policy/index.md create mode 100644 docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md create mode 100644 docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md create mode 100644 docs/awscc-docs/stackql-provider-registry.mdx diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index e270b0fda1..c569762149 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -78,7 +78,7 @@ jobs: if [ $PROVIDER == "root" ]; then echo "adding vanity url redirects to _redirects file.." touch ./build/_redirects - array=( aws azure azure-extras azure-isv azure-stack digitalocean firebase github google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog ) + array=( aws awscc azure azure-extras azure-isv azure-stack digitalocean firebase github google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog ) for i in "${array[@]}" do echo "adding redirects for $i" diff --git a/README.md b/README.md index b59adab2d9..c42c72230b 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ This repository contains documentation for StackQL providers, which is published | Netlify Deploy Datadog | [![Netlify Status](https://api.netlify.com/api/v1/badges/9e76122d-09bd-4938-a50f-3b4196e94f0c/deploy-status)](https://app.netlify.com/sites/stackql-datadog-docs/deploys) | [datadog-docs.stackql.io](https://datadog-docs.stackql.io)
[datadog.stackql.io](https://datadog.stackql.io) | | Netlify Deploy Azure ISV | [![Netlify Status](https://api.netlify.com/api/v1/badges/35fc840c-0494-462f-9b3f-cbd3418a3c78/deploy-status)](https://app.netlify.com/sites/stackql-azure-isv-docs/deploys) | [azure-isv-docs.stackql.io](https://azure-isv-docs.stackql.io)
[azure-isv.stackql.io](https://azure-isv.stackql.io) | | Netlify Deploy Azure Stack | [![Netlify Status](https://api.netlify.com/api/v1/badges/53abcb20-0194-41dd-b466-4d933cfffcad/deploy-status)](https://app.netlify.com/sites/stackql-azure-stack-docs/deploys) | [azure-stack-docs.stackql.io](https://azure-stack-docs.stackql.io)
[azure-stack.stackql.io](https://azure-stack.stackql.io) | +| Netlify Deploy AWS Cloud Control | [![Netlify Status](https://api.netlify.com/api/v1/badges/b214d7f4-4c43-43b5-a584-19d2d18902f1/deploy-status)](https://app.netlify.com/sites/stackql-awscc-docs/deploys) | [awscc-docs.stackql.io](https://awscc-docs.stackql.io)
[awscc.stackql.io](https://awscc.stackql.io) | ## Adding Docs for a New Provider diff --git a/ci-scripts/get-providers-to-deploy.js b/ci-scripts/get-providers-to-deploy.js index aa3a4d6ac9..757c117a7e 100644 --- a/ci-scripts/get-providers-to-deploy.js +++ b/ci-scripts/get-providers-to-deploy.js @@ -8,6 +8,7 @@ const isMatchRegex = (path) => regex.test(path); const rootName = 'root' const allProviders = [ 'aws', + 'awscc', 'azure', 'azure_extras', 'azure_isv', diff --git a/docs/awscc-docs/index.md b/docs/awscc-docs/index.md new file mode 100644 index 0000000000..50195b72b5 --- /dev/null +++ b/docs/awscc-docs/index.md @@ -0,0 +1,302 @@ +--- +title: aws +hide_title: false +hide_table_of_contents: false +keywords: + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +id: aws-doc +slug: /providers/aws + +--- +Cloud services from AWS. + +:::info Provider Summary (v24.03.00206) + +
+
+total services: 207
+total methods: 1,703
+
+
+total resources: 1,699
+total selectable resources: 1,699
+
+
+ +::: + +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation + +To pull the latest version of the `aws` provider, run the following command: + +```bash +REGISTRY PULL aws; +``` +> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). + +## Authentication + +The following system environment variables are used for authentication by default: + +- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) +- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) + +These variables are sourced at runtime (from the local machine or as CI variables/secrets). + +
+ +Using different environment variables + +To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: + +```bash + +AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}' +stackql shell --auth="${AUTH}" + +``` +or using PowerShell: + +```powershell + +$Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}" +stackql.exe shell --auth=$Auth + +``` +
+ + +## Server Parameters + + +The following parameter is required for the `aws` provider: + +- `region` - AWS region (e.g. `us-east-1`) + +This parameter must be supplied to the `WHERE` clause of each `SELECT` statement. + +## Services +
+
+accessanalyzer
+acmpca
+amplify
+amplifyuibuilder
+apigateway
+apigatewayv2
+appconfig
+appflow
+appintegrations
+applicationautoscaling
+applicationinsights
+apprunner
+appstream
+appsync
+aps
+arczonalshift
+athena
+auditmanager
+autoscaling
+b2bi
+backup
+backupgateway
+batch
+billingconductor
+budgets
+cassandra
+ce
+certificatemanager
+chatbot
+cleanrooms
+cloud_control
+cloudformation
+cloudfront
+cloudtrail
+cloudwatch
+codeartifact
+codebuild
+codedeploy
+codeguruprofiler
+codegurureviewer
+codepipeline
+codestarconnections
+codestarnotifications
+cognito
+comprehend
+config
+connect
+connectcampaigns
+controltower
+cur
+customerprofiles
+databrew
+datapipeline
+datasync
+datazone
+detective
+devopsguru
+directoryservice
+dms
+docdbelastic
+dynamodb
+ecr
+ecs
+efs
+eks
+elasticache
+elasticbeanstalk
+elasticloadbalancingv2
+emr
+emrcontainers
+emrserverless
+entityresolution
+events
+eventschemas
+evidently
+finspace
+fis
+fms
+forecast
+frauddetector
+fsx
+gamelift
+globalaccelerator
+glue
+grafana
+greengrassv2
+groundstation
+guardduty
+healthimaging
+healthlake
+iam
+identitystore
+imagebuilder
+inspector
+inspectorv2
+internetmonitor
+iot
+iotanalytics
+iotcoredeviceadvisor
+iotevents
+iotfleethub
+iotfleetwise
+iotsitewise
+iottwinmaker
+
+
+iotwireless
+ivs
+ivschat
+kafkaconnect
+kendra
+kendraranking
+kinesis
+kinesisanalyticsv2
+kinesisfirehose
+kinesisvideo
+kms
+lakeformation
+lambda
+lex
+licensemanager
+lightsail
+location
+logs
+lookoutequipment
+lookoutmetrics
+lookoutvision
+m2
+macie
+managedblockchain
+mediaconnect
+medialive
+mediapackage
+mediapackagev2
+mediatailor
+memorydb
+msk
+mwaa
+neptune
+neptunegraph
+networkfirewall
+networkmanager
+nimblestudio
+oam
+omics
+opensearchserverless
+opensearchservice
+opsworkscm
+organizations
+osis
+panorama
+pcaconnectorad
+personalize
+pinpoint
+pipes
+proton
+qldb
+quicksight
+ram
+rds
+redshift
+redshiftserverless
+refactorspaces
+rekognition
+resiliencehub
+resourceexplorer2
+resourcegroups
+robomaker
+rolesanywhere
+route53
+route53recoverycontrol
+route53recoveryreadiness
+route53resolver
+rum
+s3
+s3express
+s3objectlambda
+s3outposts
+sagemaker
+scheduler
+secretsmanager
+securityhub
+servicecatalog
+servicecatalogappregistry
+ses
+shield
+signer
+simspaceweaver
+sns
+sqs
+ssm
+ssmcontacts
+ssmincidents
+sso
+stepfunctions
+supportapp
+synthetics
+systemsmanagersap
+timestream
+transfer
+verifiedpermissions
+voiceid
+vpclattice
+wafv2
+wisdom
+workspaces
+workspacesthinclient
+workspacesweb
+xray
+
+
diff --git a/docs/awscc-docs/providers/awscc/accessanalyzer/analyzer/index.md b/docs/awscc-docs/providers/awscc/accessanalyzer/analyzer/index.md new file mode 100644 index 0000000000..582ba3d051 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/accessanalyzer/analyzer/index.md @@ -0,0 +1,80 @@ +--- +title: analyzer +hide_title: false +hide_table_of_contents: false +keywords: + - analyzer + - 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 +--- +Gets an individual analyzer resource + +## Overview + + + + + +
Nameanalyzer
TypeResource
Descriptionanalyzer
Idawscc.accessanalyzer.analyzer
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
analyzer_namestringAnalyzer name
archive_rulesarray
arnstringAmazon Resource Name (ARN) of the analyzer
tagsarrayAn array of key-value pairs to apply to this resource.
typestringThe type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS
analyzer_configurationobjectThe configuration for the analyzer
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the analyzer resource, the following permissions are required: + +### Read +
+access-analyzer:ListAnalyzers,
+access-analyzer:GetAnalyzer,
+access-analyzer:ListArchiveRules
+ +### Update +
+access-analyzer:CreateArchiveRule,
+access-analyzer:DeleteArchiveRule,
+access-analyzer:ListAnalyzers,
+access-analyzer:TagResource,
+access-analyzer:UntagResource,
+access-analyzer:UpdateArchiveRule
+ +### Delete +
+access-analyzer:DeleteAnalyzer
+ + +## Example +```sql +SELECT +region, +analyzer_name, +archive_rules, +arn, +tags, +type, +analyzer_configuration +FROM awscc.accessanalyzer.analyzer +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md b/docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md new file mode 100644 index 0000000000..5a83bbcc9d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md @@ -0,0 +1,62 @@ +--- +title: analyzers +hide_title: false +hide_table_of_contents: false +keywords: + - analyzers + - 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 +--- +Retrieves a list of analyzers in a region + +## Overview + + + + + +
Nameanalyzers
TypeResource
Descriptionanalyzers
Idawscc.accessanalyzer.analyzers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the analyzer
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the analyzers resource, the following permissions are required: + +### Create +
+access-analyzer:CreateAnalyzer,
+access-analyzer:TagResource,
+iam:CreateServiceLinkedRole,
+organizations:ListAWSServiceAccessForOrganization,
+organizations:ListDelegatedAdministrators
+ +### List +
+access-analyzer:ListAnalyzers
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.accessanalyzer.analyzers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/accessanalyzer/index.md b/docs/awscc-docs/providers/awscc/accessanalyzer/index.md new file mode 100644 index 0000000000..1a16250a36 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/accessanalyzer/index.md @@ -0,0 +1,39 @@ +--- +title: accessanalyzer +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The accessanalyzer service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+analyzer +
+
+analyzers +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificate/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificate/index.md new file mode 100644 index 0000000000..a59b08b8e4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/certificate/index.md @@ -0,0 +1,80 @@ +--- +title: certificate +hide_title: false +hide_table_of_contents: false +keywords: + - certificate + - 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 +--- +Gets an individual certificate resource + +## Overview + + + + + +
Namecertificate
TypeResource
Descriptioncertificate
Idawscc.acmpca.certificate
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
api_passthroughobjectSpecifies X.509 certificate information to be included in the issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored.
certificate_authority_arnstringThe Amazon Resource Name (ARN) for the private CA issues the certificate.
certificate_signing_requeststringThe certificate signing request (CSR) for the certificate.
signing_algorithmstringThe name of the algorithm that will be used to sign the certificate to be issued. <br/> This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.<br/> The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
template_arnstringSpecifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).
validityobjectThe period of time during which the certificate will be valid.
validity_not_beforeobjectInformation describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.<br/> By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the “Not Before” value. <br/> Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.<br/> The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``.
certificatestring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +
+acm-pca:GetCertificate
+ +### Delete +
+acm-pca:GetCertificate
+ +### Update +
+
+ + +## Example +```sql +SELECT +region, +api_passthrough, +certificate_authority_arn, +certificate_signing_request, +signing_algorithm, +template_arn, +validity, +validity_not_before, +certificate, +arn +FROM awscc.acmpca.certificate +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +AND data__Identifier = '<CertificateAuthorityArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md new file mode 100644 index 0000000000..9b0f808f11 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md @@ -0,0 +1,63 @@ +--- +title: certificate_authorities +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authorities + - 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 +--- +Retrieves a list of certificate_authorities in a region + +## Overview + + + + + +
Namecertificate_authorities
TypeResource
Descriptioncertificate_authorities
Idawscc.acmpca.certificate_authorities
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedThe Amazon Resource Name (ARN) of the certificate authority.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate_authorities resource, the following permissions are required: + +### Create +
+acm-pca:CreateCertificateAuthority,
+acm-pca:DescribeCertificateAuthority,
+acm-pca:GetCertificateAuthorityCsr
+ +### List +
+acm-pca:DescribeCertificateAuthority,
+acm-pca:GetCertificateAuthorityCsr,
+acm-pca:ListCertificateAuthorities,
+acm-pca:ListTags
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.acmpca.certificate_authorities +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md new file mode 100644 index 0000000000..b61f9fe630 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md @@ -0,0 +1,89 @@ +--- +title: certificate_authority +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authority + - 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 +--- +Gets an individual certificate_authority resource + +## Overview + + + + + +
Namecertificate_authority
TypeResource
Descriptioncertificate_authority
Idawscc.acmpca.certificate_authority
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the certificate authority.
typestringThe type of the certificate authority.
key_algorithmstringPublic key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
signing_algorithmstringAlgorithm your CA uses to sign certificate requests.
subjectobjectStructure that contains X.500 distinguished name information for your CA.
revocation_configurationobjectCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
tagsarray
certificate_signing_requeststringThe base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
csr_extensionsobjectStructure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
key_storage_security_standardstringKeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
usage_modestringUsage mode of the ceritificate authority.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate_authority resource, the following permissions are required: + +### Read +
+acm-pca:DescribeCertificateAuthority,
+acm-pca:GetCertificateAuthorityCsr,
+acm-pca:ListTags
+ +### Update +
+acm-pca:ListTags,
+acm-pca:TagCertificateAuthority,
+acm-pca:UntagCertificateAuthority,
+acm-pca:UpdateCertificateAuthority
+ +### Delete +
+acm-pca:DeleteCertificateAuthority,
+acm-pca:DescribeCertificateAuthority
+ + +## Example +```sql +SELECT +region, +arn, +type, +key_algorithm, +signing_algorithm, +subject, +revocation_configuration, +tags, +certificate_signing_request, +csr_extensions, +key_storage_security_standard, +usage_mode +FROM awscc.acmpca.certificate_authority +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activation/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activation/index.md new file mode 100644 index 0000000000..84304652ec --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activation/index.md @@ -0,0 +1,73 @@ +--- +title: certificate_authority_activation +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authority_activation + - 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 +--- +Gets an individual certificate_authority_activation resource + +## Overview + + + + + +
Namecertificate_authority_activation
TypeResource
Descriptioncertificate_authority_activation
Idawscc.acmpca.certificate_authority_activation
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
certificate_authority_arnstringArn of the Certificate Authority.
certificatestringCertificate Authority certificate that will be installed in the Certificate Authority.
certificate_chainstringCertificate chain for the Certificate Authority certificate.
statusstringThe status of the Certificate Authority.
complete_certificate_chainstringThe complete certificate chain, including the Certificate Authority certificate.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate_authority_activation resource, the following permissions are required: + +### Read +
+acm-pca:GetCertificateAuthorityCertificate,
+acm-pca:DescribeCertificateAuthority
+ +### Delete +
+acm-pca:UpdateCertificateAuthority
+ +### Update +
+acm-pca:ImportCertificateAuthorityCertificate,
+acm-pca:UpdateCertificateAuthority
+ + +## Example +```sql +SELECT +region, +certificate_authority_arn, +certificate, +certificate_chain, +status, +complete_certificate_chain +FROM awscc.acmpca.certificate_authority_activation +WHERE region = 'us-east-1' +AND data__Identifier = '<CertificateAuthorityArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activations/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activations/index.md new file mode 100644 index 0000000000..a1a5929f6a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activations/index.md @@ -0,0 +1,55 @@ +--- +title: certificate_authority_activations +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authority_activations + - 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 +--- +Retrieves a list of certificate_authority_activations in a region + +## Overview + + + + + +
Namecertificate_authority_activations
TypeResource
Descriptioncertificate_authority_activations
Idawscc.acmpca.certificate_authority_activations
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_authority_arnstringArn of the Certificate Authority.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate_authority_activations resource, the following permissions are required: + +### Create +
+acm-pca:ImportCertificateAuthorityCertificate,
+acm-pca:UpdateCertificateAuthority
+ + +## Example +```sql +SELECT +region, +certificate_authority_arn +FROM awscc.acmpca.certificate_authority_activations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificates/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificates/index.md new file mode 100644 index 0000000000..7e16c5648a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/certificates/index.md @@ -0,0 +1,57 @@ +--- +title: certificates +hide_title: false +hide_table_of_contents: false +keywords: + - certificates + - 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 +--- +Retrieves a list of certificates in a region + +## Overview + + + + + +
Namecertificates
TypeResource
Descriptioncertificates
Idawscc.acmpca.certificates
+ +## Fields + + + + + + +
NameDatatypeDescription
arnundefined
certificate_authority_arnundefinedThe Amazon Resource Name (ARN) for the private CA issues the certificate.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +
+acm-pca:IssueCertificate,
+acm-pca:GetCertificate
+ + +## Example +```sql +SELECT +region, +arn, +certificate_authority_arn +FROM awscc.acmpca.certificates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/acmpca/index.md b/docs/awscc-docs/providers/awscc/acmpca/index.md new file mode 100644 index 0000000000..af39f3fd33 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/index.md @@ -0,0 +1,45 @@ +--- +title: acmpca +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The acmpca service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+certificate
+certificate_authorities
+certificate_authority
+certificate_authority_activation +
+
+certificate_authority_activations
+certificates
+permission
+permissions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/acmpca/permission/index.md b/docs/awscc-docs/providers/awscc/acmpca/permission/index.md new file mode 100644 index 0000000000..8317541c46 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/permission/index.md @@ -0,0 +1,66 @@ +--- +title: permission +hide_title: false +hide_table_of_contents: false +keywords: + - permission + - 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 +--- +Gets an individual permission resource + +## Overview + + + + + +
Namepermission
TypeResource
Descriptionpermission
Idawscc.acmpca.permission
+ +## Fields + + + + + + + + +
NameDatatypeDescription
actionsarrayThe actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided.
certificate_authority_arnstringThe Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
principalstringThe AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
source_accountstringThe ID of the calling account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permission resource, the following permissions are required: + +### Read +
+acm-pca:ListPermissions
+ +### Delete +
+acm-pca:DeletePermission
+ + +## Example +```sql +SELECT +region, +actions, +certificate_authority_arn, +principal, +source_account +FROM awscc.acmpca.permission +WHERE region = 'us-east-1' +AND data__Identifier = '<CertificateAuthorityArn>' +AND data__Identifier = '<Principal>' +``` diff --git a/docs/awscc-docs/providers/awscc/acmpca/permissions/index.md b/docs/awscc-docs/providers/awscc/acmpca/permissions/index.md new file mode 100644 index 0000000000..0fac77bfee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/acmpca/permissions/index.md @@ -0,0 +1,57 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - permissions + - 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 +--- +Retrieves a list of permissions in a region + +## Overview + + + + + +
Namepermissions
TypeResource
Descriptionpermissions
Idawscc.acmpca.permissions
+ +## Fields + + + + + + +
NameDatatypeDescription
certificate_authority_arnstringThe Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
principalstringThe AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +
+acm-pca:CreatePermission,
+acm-pca:ListPermissions
+ + +## Example +```sql +SELECT +region, +certificate_authority_arn, +principal +FROM awscc.acmpca.permissions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/amplify/app/index.md b/docs/awscc-docs/providers/awscc/amplify/app/index.md new file mode 100644 index 0000000000..056ca79028 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplify/app/index.md @@ -0,0 +1,120 @@ +--- +title: app +hide_title: false +hide_table_of_contents: false +keywords: + - app + - 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 +--- +Gets an individual app resource + +## Overview + + + + + +
Nameapp
TypeResource
Descriptionapp
Idawscc.amplify.app
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
access_tokenstring
app_idstring
app_namestring
arnstring
auto_branch_creation_configobject
basic_auth_configobject
build_specstring
custom_headersstring
custom_rulesarray
default_domainstring
descriptionstring
enable_branch_auto_deletionboolean
environment_variablesarray
i_am_service_rolestring
namestring
oauth_tokenstring
platformstring
repositorystring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app resource, the following permissions are required: + +### Delete +
+amplify:GetApp,
+amplify:DeleteApp,
+codecommit:GetRepository,
+codecommit:GetRepositoryTriggers,
+codecommit:PutRepositoryTriggers,
+sns:Unsubscribe,
+iam:PassRole
+ +### Read +
+amplify:GetApp,
+amplify:ListTagsForResource,
+codecommit:GetRepository,
+codecommit:GetRepositoryTriggers,
+iam:PassRole
+ +### Update +
+amplify:GetApp,
+amplify:UpdateApp,
+amplify:ListTagsForResource,
+amplify:TagResource,
+amplify:UntagResource,
+codecommit:GetRepository,
+codecommit:PutRepositoryTriggers,
+codecommit:GetRepositoryTriggers,
+sns:CreateTopic,
+sns:Subscribe,
+sns:Unsubscribe,
+iam:PassRole
+ + +## Example +```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, +i_am_service_role, +name, +oauth_token, +platform, +repository, +tags +FROM awscc.amplify.app +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/amplify/apps/index.md b/docs/awscc-docs/providers/awscc/amplify/apps/index.md new file mode 100644 index 0000000000..bb165ad953 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplify/apps/index.md @@ -0,0 +1,69 @@ +--- +title: apps +hide_title: false +hide_table_of_contents: false +keywords: + - apps + - 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 +--- +Retrieves a list of apps in a region + +## Overview + + + + + +
Nameapps
TypeResource
Descriptionapps
Idawscc.amplify.apps
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the apps resource, the following permissions are required: + +### Create +
+amplify:GetApp,
+amplify:CreateApp,
+amplify:TagResource,
+codecommit:GetRepository,
+codecommit:PutRepositoryTriggers,
+codecommit:GetRepositoryTriggers,
+sns:CreateTopic,
+sns:Subscribe,
+iam:PassRole
+ +### List +
+amplify:GetApp,
+amplify:ListApps,
+amplify:ListTagsForResource,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.amplify.apps +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/amplify/branch/index.md b/docs/awscc-docs/providers/awscc/amplify/branch/index.md new file mode 100644 index 0000000000..0cf03211f0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplify/branch/index.md @@ -0,0 +1,117 @@ +--- +title: branch +hide_title: false +hide_table_of_contents: false +keywords: + - branch + - 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 +--- +Gets an individual branch resource + +## Overview + + + + + +
Namebranch
TypeResource
Descriptionbranch
Idawscc.amplify.branch
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
arnstring
basic_auth_configobject
backendobject
branch_namestring
build_specstring
descriptionstring
enable_auto_buildboolean
enable_performance_modeboolean
enable_pull_request_previewboolean
environment_variablesarray
frameworkstring
pull_request_environment_namestring
stagestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the branch resource, the following permissions are required: + +### Delete +
+amplify:GetBranch,
+amplify:DeleteBranch,
+codecommit:GetRepository,
+codecommit:GetRepositoryTriggers,
+sns:Unsubscribe,
+iam:PassRole
+ +### Read +
+amplify:GetBranch,
+amplify:ListTagsForResource,
+codecommit:GetRepository,
+codecommit:GetRepositoryTriggers,
+s3:GetObject,
+s3:GetObjectAcl,
+iam:PassRole
+ +### Update +
+amplify:GetBranch,
+amplify:UpdateBranch,
+amplify:ListTagsForResource,
+amplify:TagResource,
+amplify:UntagResource,
+codecommit:GetRepository,
+codecommit:PutRepositoryTriggers,
+codecommit:GetRepositoryTriggers,
+s3:GetObject,
+s3:GetObjectAcl,
+s3:PutObject,
+s3:PutObjectAcl,
+sns:CreateTopic,
+sns:Subscribe,
+sns:Unsubscribe,
+iam:PassRole
+ + +## Example +```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, +tags +FROM awscc.amplify.branch +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/amplify/branches/index.md b/docs/awscc-docs/providers/awscc/amplify/branches/index.md new file mode 100644 index 0000000000..a81e3a0aa2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplify/branches/index.md @@ -0,0 +1,73 @@ +--- +title: branches +hide_title: false +hide_table_of_contents: false +keywords: + - branches + - 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 +--- +Retrieves a list of branches in a region + +## Overview + + + + + +
Namebranches
TypeResource
Descriptionbranches
Idawscc.amplify.branches
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the branches resource, the following permissions are required: + +### Create +
+amplify:GetBranch,
+amplify:CreateBranch,
+amplify:TagResource,
+codecommit:GetRepository,
+codecommit:PutRepositoryTriggers,
+codecommit:GetRepositoryTriggers,
+s3:GetObject,
+s3:GetObjectAcl,
+s3:PutObject,
+s3:PutObjectAcl,
+sns:CreateTopic,
+sns:Subscribe,
+iam:PassRole
+ +### List +
+amplify:GetBranch,
+amplify:ListBranches,
+amplify:ListTagsForResource,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.amplify.branches +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/amplify/domain/index.md b/docs/awscc-docs/providers/awscc/amplify/domain/index.md new file mode 100644 index 0000000000..4d03938679 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplify/domain/index.md @@ -0,0 +1,98 @@ +--- +title: domain +hide_title: false +hide_table_of_contents: false +keywords: + - domain + - 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 +--- +Gets an individual domain resource + +## Overview + + + + + +
Namedomain
TypeResource
Descriptiondomain
Idawscc.amplify.domain
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
arnstring
auto_sub_domain_creation_patternsarray
auto_sub_domain_ia_mrolestring
certificate_recordstring
certificateobject
certificate_settingsobject
domain_namestring
domain_statusstring
update_statusstring
enable_auto_sub_domainboolean
status_reasonstring
sub_domain_settingsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Delete +
+amplify:DeleteDomainAssociation,
+iam:PassRole,
+amplify:DeleteDomainAssociation
+ +### Read +
+amplify:GetDomainAssociation,
+route53:ListHostedZones,
+iam:PassRole,
+amplify:ListTagsForResource
+ +### Update +
+amplify:UpdateDomainAssociation,
+route53:ListHostedZones,
+route53:ChangeResourceRecordSets,
+iam:PassRole,
+amplify:ListTagsForResource,
+amplify:TagResource,
+amplify:UntagResource
+ + +## Example +```sql +SELECT +region, +app_id, +arn, +auto_sub_domain_creation_patterns, +auto_sub_domain_ia_mrole, +certificate_record, +certificate, +certificate_settings, +domain_name, +domain_status, +update_status, +enable_auto_sub_domain, +status_reason, +sub_domain_settings +FROM awscc.amplify.domain +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/amplify/domains/index.md b/docs/awscc-docs/providers/awscc/amplify/domains/index.md new file mode 100644 index 0000000000..7444473f50 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplify/domains/index.md @@ -0,0 +1,64 @@ +--- +title: domains +hide_title: false +hide_table_of_contents: false +keywords: + - domains + - 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 +--- +Retrieves a list of domains in a region + +## Overview + + + + + +
Namedomains
TypeResource
Descriptiondomains
Idawscc.amplify.domains
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +
+amplify:CreateDomainAssociation,
+route53:ListHostedZones,
+route53:ChangeResourceRecordSets,
+iam:PassRole,
+amplify:TagResource
+ +### List +
+amplify:ListDomainAssociations,
+iam:PassRole,
+amplify:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.amplify.domains +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/amplify/index.md b/docs/awscc-docs/providers/awscc/amplify/index.md new file mode 100644 index 0000000000..144afbb223 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplify/index.md @@ -0,0 +1,43 @@ +--- +title: amplify +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The amplify service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+app
+apps
+branch +
+
+branches
+domain
+domains +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/component/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/component/index.md new file mode 100644 index 0000000000..cadd61c2f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplifyuibuilder/component/index.md @@ -0,0 +1,105 @@ +--- +title: component +hide_title: false +hide_table_of_contents: false +keywords: + - component + - 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 +--- +Gets an individual component resource + +## Overview + + + + + +
Namecomponent
TypeResource
Descriptioncomponent
Idawscc.amplifyuibuilder.component
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
binding_propertiesobject
childrenarray
collection_propertiesobject
component_typestring
created_atstring
environment_namestring
eventsobject
idstring
modified_atstring
namestring
overridesobject
propertiesobject
schema_versionstring
source_idstring
tagsobject
variantsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the component resource, the following permissions are required: + +### Read +
+amplify:GetApp,
+amplifyuibuilder:GetComponent
+ +### Update +
+amplify:GetApp,
+amplifyuibuilder:GetComponent,
+amplifyuibuilder:TagResource,
+amplifyuibuilder:UntagResource,
+amplifyuibuilder:UpdateComponent
+ +### Delete +
+amplify:GetApp,
+amplifyuibuilder:DeleteComponent,
+amplifyuibuilder:GetComponent,
+amplifyuibuilder:UntagResource
+ + +## Example +```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, +tags, +variants +FROM awscc.amplifyuibuilder.component +WHERE region = 'us-east-1' +AND data__Identifier = '<AppId>' +AND data__Identifier = '<EnvironmentName>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md new file mode 100644 index 0000000000..826c4f60f9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md @@ -0,0 +1,66 @@ +--- +title: components +hide_title: false +hide_table_of_contents: false +keywords: + - components + - 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 +--- +Retrieves a list of components in a region + +## Overview + + + + + +
Namecomponents
TypeResource
Descriptioncomponents
Idawscc.amplifyuibuilder.components
+ +## Fields + + + + + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the components resource, the following permissions are required: + +### Create +
+amplify:GetApp,
+amplifyuibuilder:CreateComponent,
+amplifyuibuilder:GetComponent,
+amplifyuibuilder:TagResource
+ +### List +
+amplify:GetApp,
+amplifyuibuilder:ListComponents
+ + +## Example +```sql +SELECT +region, +app_id, +environment_name, +id +FROM awscc.amplifyuibuilder.components +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md new file mode 100644 index 0000000000..2b22311529 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md @@ -0,0 +1,98 @@ +--- +title: form +hide_title: false +hide_table_of_contents: false +keywords: + - form + - 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 +--- +Gets an individual form resource + +## Overview + + + + + +
Nameform
TypeResource
Descriptionform
Idawscc.amplifyuibuilder.form
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
ctaobject
data_typeobject
environment_namestring
fieldsobject
form_action_typestring
idstring
label_decoratorstring
namestring
schema_versionstring
sectional_elementsobject
styleobject
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the form resource, the following permissions are required: + +### Read +
+amplify:GetApp,
+amplifyuibuilder:GetForm,
+amplifyuibuilder:TagResource
+ +### Update +
+amplify:GetApp,
+amplifyuibuilder:GetForm,
+amplifyuibuilder:TagResource,
+amplifyuibuilder:UntagResource,
+amplifyuibuilder:UpdateForm
+ +### Delete +
+amplify:GetApp,
+amplifyuibuilder:DeleteForm,
+amplifyuibuilder:TagResource,
+amplifyuibuilder:UntagResource
+ + +## Example +```sql +SELECT +region, +app_id, +cta, +data_type, +environment_name, +fields, +form_action_type, +id, +label_decorator, +name, +schema_version, +sectional_elements, +style, +tags +FROM awscc.amplifyuibuilder.form +WHERE region = 'us-east-1' +AND data__Identifier = '<AppId>' +AND data__Identifier = '<EnvironmentName>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md new file mode 100644 index 0000000000..d1d1575342 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md @@ -0,0 +1,67 @@ +--- +title: forms +hide_title: false +hide_table_of_contents: false +keywords: + - forms + - 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 +--- +Retrieves a list of forms in a region + +## Overview + + + + + +
Nameforms
TypeResource
Descriptionforms
Idawscc.amplifyuibuilder.forms
+ +## Fields + + + + + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the forms resource, the following permissions are required: + +### Create +
+amplify:GetApp,
+amplifyuibuilder:CreateForm,
+amplifyuibuilder:GetForm,
+amplifyuibuilder:TagResource,
+amplifyuibuilder:UntagResource
+ +### List +
+amplify:GetApp,
+amplifyuibuilder:ListForms
+ + +## Example +```sql +SELECT +region, +app_id, +environment_name, +id +FROM awscc.amplifyuibuilder.forms +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md new file mode 100644 index 0000000000..00dcbbad9a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md @@ -0,0 +1,43 @@ +--- +title: amplifyuibuilder +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The amplifyuibuilder service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+component
+components
+form +
+
+forms
+theme
+themes +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/theme/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/theme/index.md new file mode 100644 index 0000000000..80446a74ae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplifyuibuilder/theme/index.md @@ -0,0 +1,88 @@ +--- +title: theme +hide_title: false +hide_table_of_contents: false +keywords: + - theme + - 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 +--- +Gets an individual theme resource + +## Overview + + + + + +
Nametheme
TypeResource
Descriptiontheme
Idawscc.amplifyuibuilder.theme
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
created_atstring
environment_namestring
idstring
modified_atstring
namestring
overridesarray
tagsobject
valuesarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the theme resource, the following permissions are required: + +### Read +
+amplify:GetApp,
+amplifyuibuilder:GetTheme
+ +### Update +
+amplify:GetApp,
+amplifyuibuilder:GetTheme,
+amplifyuibuilder:TagResource,
+amplifyuibuilder:UntagResource,
+amplifyuibuilder:UpdateTheme
+ +### Delete +
+amplify:GetApp,
+amplifyuibuilder:DeleteTheme,
+amplifyuibuilder:UntagResource
+ + +## Example +```sql +SELECT +region, +app_id, +created_at, +environment_name, +id, +modified_at, +name, +overrides, +tags, +values +FROM awscc.amplifyuibuilder.theme +WHERE region = 'us-east-1' +AND data__Identifier = '<AppId>' +AND data__Identifier = '<EnvironmentName>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md new file mode 100644 index 0000000000..f0618cf815 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md @@ -0,0 +1,66 @@ +--- +title: themes +hide_title: false +hide_table_of_contents: false +keywords: + - themes + - 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 +--- +Retrieves a list of themes in a region + +## Overview + + + + + +
Namethemes
TypeResource
Descriptionthemes
Idawscc.amplifyuibuilder.themes
+ +## Fields + + + + + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the themes resource, the following permissions are required: + +### Create +
+amplify:GetApp,
+amplifyuibuilder:CreateTheme,
+amplifyuibuilder:GetTheme,
+amplifyuibuilder:TagResource
+ +### List +
+amplify:GetApp,
+amplifyuibuilder:ListThemes
+ + +## Example +```sql +SELECT +region, +app_id, +environment_name, +id +FROM awscc.amplifyuibuilder.themes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/account/index.md b/docs/awscc-docs/providers/awscc/apigateway/account/index.md new file mode 100644 index 0000000000..63b3f7e56e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/account/index.md @@ -0,0 +1,67 @@ +--- +title: account +hide_title: false +hide_table_of_contents: false +keywords: + - account + - 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 +--- +Gets an individual account resource + +## Overview + + + + + +
Nameaccount
TypeResource
Descriptionaccount
Idawscc.apigateway.account
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
cloud_watch_role_arnstringThe ARN of an Amazon CloudWatch role for the current Account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:PATCH,
+iam:GetRole,
+iam:PassRole
+ +### Delete +
+
+ + +## Example +```sql +SELECT +region, +id, +cloud_watch_role_arn +FROM awscc.apigateway.account +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/accounts/index.md b/docs/awscc-docs/providers/awscc/apigateway/accounts/index.md new file mode 100644 index 0000000000..95597c9575 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/accounts/index.md @@ -0,0 +1,56 @@ +--- +title: accounts +hide_title: false +hide_table_of_contents: false +keywords: + - accounts + - 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 +--- +Retrieves a list of accounts in a region + +## Overview + + + + + +
Nameaccounts
TypeResource
Descriptionaccounts
Idawscc.apigateway.accounts
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Create +
+apigateway:PATCH,
+iam:GetRole,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.apigateway.accounts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/api_key/index.md b/docs/awscc-docs/providers/awscc/apigateway/api_key/index.md new file mode 100644 index 0000000000..1f3dc436ab --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/api_key/index.md @@ -0,0 +1,83 @@ +--- +title: api_key +hide_title: false +hide_table_of_contents: false +keywords: + - api_key + - 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 +--- +Gets an individual api_key resource + +## Overview + + + + + +
Nameapi_key
TypeResource
Descriptionapi_key
Idawscc.apigateway.api_key
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
a_pi_key_idstring
customer_idstringAn MKT customer identifier, when integrating with the AWS SaaS Marketplace.
descriptionstringThe description of the ApiKey.
enabledbooleanSpecifies whether the ApiKey can be used by callers.
generate_distinct_idbooleanSpecifies 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.
namestringA 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).<br/> 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.
stage_keysarrayDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
tagsarrayThe 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.
valuestringSpecifies a value of the API key.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_key resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:PATCH,
+apigateway:PUT,
+apigateway:DELETE
+ +### Delete +
+apigateway:DELETE,
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +a_pi_key_id, +customer_id, +description, +enabled, +generate_distinct_id, +name, +stage_keys, +tags, +value +FROM awscc.apigateway.api_key +WHERE region = 'us-east-1' +AND data__Identifier = '<APIKeyId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md b/docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md new file mode 100644 index 0000000000..a81ee4ec05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md @@ -0,0 +1,60 @@ +--- +title: api_keys +hide_title: false +hide_table_of_contents: false +keywords: + - api_keys + - 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 +--- +Retrieves a list of api_keys in a region + +## Overview + + + + + +
Nameapi_keys
TypeResource
Descriptionapi_keys
Idawscc.apigateway.api_keys
+ +## Fields + + + + + +
NameDatatypeDescription
a_pi_key_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_keys resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET,
+apigateway:PUT
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +a_pi_key_id +FROM awscc.apigateway.api_keys +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md b/docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md new file mode 100644 index 0000000000..1016df7c5d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md @@ -0,0 +1,86 @@ +--- +title: authorizer +hide_title: false +hide_table_of_contents: false +keywords: + - authorizer + - 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 +--- +Gets an individual authorizer resource + +## Overview + + + + + +
Nameauthorizer
TypeResource
Descriptionauthorizer
Idawscc.apigateway.authorizer
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
authorizer_idstring
auth_typestringOptional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_credentialsstringSpecifies 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.
authorizer_result_ttl_in_secondsintegerThe 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.
authorizer_uristringSpecifies 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``.
identity_sourcestringThe 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 thi
identity_validation_expressionstringA 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.
namestringThe name of the authorizer.
provider_ar_nsarrayA 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.
typestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the authorizer resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:PATCH,
+iam:PassRole
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +rest_api_id, +authorizer_id, +auth_type, +authorizer_credentials, +authorizer_result_ttl_in_seconds, +authorizer_uri, +identity_source, +identity_validation_expression, +name, +provider_ar_ns, +type +FROM awscc.apigateway.authorizer +WHERE region = 'us-east-1' +AND data__Identifier = '<RestApiId>' +AND data__Identifier = '<AuthorizerId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md b/docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md new file mode 100644 index 0000000000..3ba5744f9f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md @@ -0,0 +1,61 @@ +--- +title: authorizers +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers + - 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 +--- +Retrieves a list of authorizers in a region + +## Overview + + + + + +
Nameauthorizers
TypeResource
Descriptionauthorizers
Idawscc.apigateway.authorizers
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
authorizer_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +
+apigateway:POST,
+iam:PassRole
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +rest_api_id, +authorizer_id +FROM awscc.apigateway.authorizers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/base_path_mapping/index.md b/docs/awscc-docs/providers/awscc/apigateway/base_path_mapping/index.md new file mode 100644 index 0000000000..7bf6fa7e50 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/base_path_mapping/index.md @@ -0,0 +1,72 @@ +--- +title: base_path_mapping +hide_title: false +hide_table_of_contents: false +keywords: + - base_path_mapping + - 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 +--- +Gets an individual base_path_mapping resource + +## Overview + + + + + +
Namebase_path_mapping
TypeResource
Descriptionbase_path_mapping
Idawscc.apigateway.base_path_mapping
+ +## Fields + + + + + + + + +
NameDatatypeDescription
base_pathstringThe base path name that callers of the API must provide as part of the URL after the domain name.
domain_namestringThe domain name of the BasePathMapping resource to be described.
rest_api_idstringThe string identifier of the associated RestApi.
stagestringThe name of the associated stage.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the base_path_mapping resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:DELETE,
+apigateway:PATCH
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +base_path, +domain_name, +rest_api_id, +stage +FROM awscc.apigateway.base_path_mapping +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +AND data__Identifier = '<BasePath>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/base_path_mappings/index.md b/docs/awscc-docs/providers/awscc/apigateway/base_path_mappings/index.md new file mode 100644 index 0000000000..8654d77cb5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/base_path_mappings/index.md @@ -0,0 +1,61 @@ +--- +title: base_path_mappings +hide_title: false +hide_table_of_contents: false +keywords: + - base_path_mappings + - 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 +--- +Retrieves a list of base_path_mappings in a region + +## Overview + + + + + +
Namebase_path_mappings
TypeResource
Descriptionbase_path_mappings
Idawscc.apigateway.base_path_mappings
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_namestringThe domain name of the BasePathMapping resource to be described.
base_pathstringThe base path name that callers of the API must provide as part of the URL after the domain name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the base_path_mappings resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +domain_name, +base_path +FROM awscc.apigateway.base_path_mappings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md b/docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md new file mode 100644 index 0000000000..813c6828f6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md @@ -0,0 +1,70 @@ +--- +title: client_certificate +hide_title: false +hide_table_of_contents: false +keywords: + - client_certificate + - 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 +--- +Gets an individual client_certificate resource + +## Overview + + + + + +
Nameclient_certificate
TypeResource
Descriptionclient_certificate
Idawscc.apigateway.client_certificate
+ +## Fields + + + + + + + +
NameDatatypeDescription
client_certificate_idstring
descriptionstringThe description of the client certificate.
tagsarrayThe collection of tags. Each tag element is associated with a given resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the client_certificate resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:PATCH,
+apigateway:PUT,
+apigateway:DELETE
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +client_certificate_id, +description, +tags +FROM awscc.apigateway.client_certificate +WHERE region = 'us-east-1' +AND data__Identifier = '<ClientCertificateId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md b/docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md new file mode 100644 index 0000000000..a0e149d996 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md @@ -0,0 +1,60 @@ +--- +title: client_certificates +hide_title: false +hide_table_of_contents: false +keywords: + - client_certificates + - 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 +--- +Retrieves a list of client_certificates in a region + +## Overview + + + + + +
Nameclient_certificates
TypeResource
Descriptionclient_certificates
Idawscc.apigateway.client_certificates
+ +## Fields + + + + + +
NameDatatypeDescription
client_certificate_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the client_certificates resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET,
+apigateway:PUT
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +client_certificate_id +FROM awscc.apigateway.client_certificates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/deployment/index.md b/docs/awscc-docs/providers/awscc/apigateway/deployment/index.md new file mode 100644 index 0000000000..60a6fc5504 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/deployment/index.md @@ -0,0 +1,78 @@ +--- +title: deployment +hide_title: false +hide_table_of_contents: false +keywords: + - deployment + - 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 +--- +Gets an individual deployment resource + +## Overview + + + + + +
Namedeployment
TypeResource
Descriptiondeployment
Idawscc.apigateway.deployment
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
deployment_idstring
deployment_canary_settingsobjectThe input configuration for a canary deployment.
descriptionstringThe description for the Deployment resource to create.
rest_api_idstringThe string identifier of the associated RestApi.
stage_descriptionobjectThe description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
stage_namestringThe name of the Stage resource for the Deployment resource to create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployment resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT,
+apigateway:DELETE
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +deployment_id, +deployment_canary_settings, +description, +rest_api_id, +stage_description, +stage_name +FROM awscc.apigateway.deployment +WHERE region = 'us-east-1' +AND data__Identifier = '<DeploymentId>' +AND data__Identifier = '<RestApiId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/deployments/index.md b/docs/awscc-docs/providers/awscc/apigateway/deployments/index.md new file mode 100644 index 0000000000..c737264988 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/deployments/index.md @@ -0,0 +1,63 @@ +--- +title: deployments +hide_title: false +hide_table_of_contents: false +keywords: + - deployments + - 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 +--- +Retrieves a list of deployments in a region + +## Overview + + + + + +
Namedeployments
TypeResource
Descriptiondeployments
Idawscc.apigateway.deployments
+ +## Fields + + + + + + +
NameDatatypeDescription
deployment_idstring
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:PATCH,
+apigateway:PUT,
+apigateway:GET
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +deployment_id, +rest_api_id +FROM awscc.apigateway.deployments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md new file mode 100644 index 0000000000..333a94db6b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md @@ -0,0 +1,71 @@ +--- +title: documentation_part +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_part + - 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 +--- +Gets an individual documentation_part resource + +## Overview + + + + + +
Namedocumentation_part
TypeResource
Descriptiondocumentation_part
Idawscc.apigateway.documentation_part
+ +## Fields + + + + + + + + +
NameDatatypeDescription
documentation_part_idstring
locationobjectThe location of the targeted API entity of the to-be-created documentation part.
propertiesstringThe 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.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the documentation_part resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:PATCH
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +documentation_part_id, +location, +properties, +rest_api_id +FROM awscc.apigateway.documentation_part +WHERE region = 'us-east-1' +AND data__Identifier = '<DocumentationPartId>' +AND data__Identifier = '<RestApiId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md new file mode 100644 index 0000000000..0cce415d44 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md @@ -0,0 +1,61 @@ +--- +title: documentation_parts +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_parts + - 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 +--- +Retrieves a list of documentation_parts in a region + +## Overview + + + + + +
Namedocumentation_parts
TypeResource
Descriptiondocumentation_parts
Idawscc.apigateway.documentation_parts
+ +## Fields + + + + + + +
NameDatatypeDescription
documentation_part_idstring
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the documentation_parts resource, the following permissions are required: + +### Create +
+apigateway:GET,
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +documentation_part_id, +rest_api_id +FROM awscc.apigateway.documentation_parts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md new file mode 100644 index 0000000000..b04519f425 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md @@ -0,0 +1,69 @@ +--- +title: documentation_version +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_version + - 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 +--- +Gets an individual documentation_version resource + +## Overview + + + + + +
Namedocumentation_version
TypeResource
Descriptiondocumentation_version
Idawscc.apigateway.documentation_version
+ +## Fields + + + + + + + +
NameDatatypeDescription
descriptionstringA description about the new documentation snapshot.
documentation_versionstringThe version identifier of the to-be-updated documentation version.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the documentation_version resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:PATCH
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +description, +documentation_version, +rest_api_id +FROM awscc.apigateway.documentation_version +WHERE region = 'us-east-1' +AND data__Identifier = '<DocumentationVersion>' +AND data__Identifier = '<RestApiId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md new file mode 100644 index 0000000000..460a8ab8f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md @@ -0,0 +1,61 @@ +--- +title: documentation_versions +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_versions + - 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 +--- +Retrieves a list of documentation_versions in a region + +## Overview + + + + + +
Namedocumentation_versions
TypeResource
Descriptiondocumentation_versions
Idawscc.apigateway.documentation_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
documentation_versionstringThe version identifier of the to-be-updated documentation version.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the documentation_versions resource, the following permissions are required: + +### Create +
+apigateway:GET,
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +documentation_version, +rest_api_id +FROM awscc.apigateway.documentation_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md b/docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md new file mode 100644 index 0000000000..dfc7332430 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md @@ -0,0 +1,85 @@ +--- +title: domain_name +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name + - 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 +--- +Gets an individual domain_name resource + +## Overview + + + + + +
Namedomain_name
TypeResource
Descriptiondomain_name
Idawscc.apigateway.domain_name
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestring
distribution_domain_namestring
distribution_hosted_zone_idstring
endpoint_configurationobject
mutual_tls_authenticationobject
regional_domain_namestring
regional_hosted_zone_idstring
certificate_arnstring
regional_certificate_arnstring
ownership_verification_certificate_arnstring
security_policystring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_name resource, the following permissions are required: + +### Read +
+apigateway:*
+ +### Update +
+apigateway:*
+ +### Delete +
+apigateway:*
+ + +## Example +```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, +tags +FROM awscc.apigateway.domain_name +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md b/docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md new file mode 100644 index 0000000000..92ce46da0c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md @@ -0,0 +1,58 @@ +--- +title: domain_names +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names + - 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 +--- +Retrieves a list of domain_names in a region + +## Overview + + + + + +
Namedomain_names
TypeResource
Descriptiondomain_names
Idawscc.apigateway.domain_names
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_names resource, the following permissions are required: + +### Create +
+apigateway:*
+ +### List +
+apigateway:*
+ + +## Example +```sql +SELECT +region, +domain_name +FROM awscc.apigateway.domain_names +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/gateway_response/index.md b/docs/awscc-docs/providers/awscc/apigateway/gateway_response/index.md new file mode 100644 index 0000000000..de3a9f947a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/gateway_response/index.md @@ -0,0 +1,71 @@ +--- +title: gateway_response +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_response + - 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 +--- +Gets an individual gateway_response resource + +## Overview + + + + + +
Namegateway_response
TypeResource
Descriptiongateway_response
Idawscc.apigateway.gateway_response
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
rest_api_idstringThe string identifier of the associated RestApi.
response_typestringThe response type of the associated GatewayResponse.
status_codestringThe HTTP status code for this GatewayResponse.
response_parametersobjectResponse parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
response_templatesobjectResponse templates of the GatewayResponse as a string-to-string map of key-value pairs.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the gateway_response resource, the following permissions are required: + +### Update +
+apigateway:GET,
+apigateway:PUT
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +id, +rest_api_id, +response_type, +status_code, +response_parameters, +response_templates +FROM awscc.apigateway.gateway_response +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md b/docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md new file mode 100644 index 0000000000..e9ab5126ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md @@ -0,0 +1,59 @@ +--- +title: gateway_responses +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_responses + - 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 +--- +Retrieves a list of gateway_responses in a region + +## Overview + + + + + +
Namegateway_responses
TypeResource
Descriptiongateway_responses
Idawscc.apigateway.gateway_responses
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the gateway_responses resource, the following permissions are required: + +### Create +
+apigateway:PUT,
+apigateway:GET
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.apigateway.gateway_responses +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/index.md b/docs/awscc-docs/providers/awscc/apigateway/index.md new file mode 100644 index 0000000000..1702e893ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/index.md @@ -0,0 +1,75 @@ +--- +title: apigateway +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The apigateway service documentation. + +:::info Service Summary + +
+
+total resources: 38
+total selectable resources: 38
+total methods: 38
+
+
+ +::: + +## Resources +
+
+account
+accounts
+api_key
+api_keys
+authorizer
+authorizers
+base_path_mapping
+base_path_mappings
+client_certificate
+client_certificates
+deployment
+deployments
+documentation_part
+documentation_parts
+documentation_version
+documentation_versions
+domain_name
+domain_names
+gateway_response +
+
+gateway_responses
+method
+methods
+model
+models
+request_validator
+request_validators
+resource
+resources
+rest_api
+rest_apis
+stage
+stages
+usage_plan
+usage_plan_key
+usage_plan_keys
+usage_plans
+vpc_link
+vpc_links +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/apigateway/method/index.md b/docs/awscc-docs/providers/awscc/apigateway/method/index.md new file mode 100644 index 0000000000..fd24693325 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/method/index.md @@ -0,0 +1,92 @@ +--- +title: method +hide_title: false +hide_table_of_contents: false +keywords: + - method + - 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 +--- +Gets an individual method resource + +## Overview + + + + + +
Namemethod
TypeResource
Descriptionmethod
Idawscc.apigateway.method
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
api_key_requiredbooleanA boolean flag specifying whether a valid ApiKey is required to invoke this method.
authorization_scopesarrayA list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
authorization_typestringThe method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.<br/> If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.
authorizer_idstringThe identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.
http_methodstringThe method's HTTP verb.
integrationobjectRepresents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration.
method_responsesarrayGets a method response associated with a given HTTP status code.
operation_namestringA human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example.
request_modelsobjectA key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
request_parametersobjectA key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
request_validator_idstringThe identifier of a RequestValidator for request validation.
resource_idstringThe Resource identifier for the MethodResponse resource.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the method resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:DELETE,
+apigateway:PUT,
+iam:PassRole
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +api_key_required, +authorization_scopes, +authorization_type, +authorizer_id, +http_method, +integration, +method_responses, +operation_name, +request_models, +request_parameters, +request_validator_id, +resource_id, +rest_api_id +FROM awscc.apigateway.method +WHERE region = 'us-east-1' +AND data__Identifier = '<RestApiId>' +AND data__Identifier = '<ResourceId>' +AND data__Identifier = '<HttpMethod>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/methods/index.md b/docs/awscc-docs/providers/awscc/apigateway/methods/index.md new file mode 100644 index 0000000000..84aecb1898 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/methods/index.md @@ -0,0 +1,60 @@ +--- +title: methods +hide_title: false +hide_table_of_contents: false +keywords: + - methods + - 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 +--- +Retrieves a list of methods in a region + +## Overview + + + + + +
Namemethods
TypeResource
Descriptionmethods
Idawscc.apigateway.methods
+ +## Fields + + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
resource_idstringThe Resource identifier for the MethodResponse resource.
http_methodstringThe method's HTTP verb.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the methods resource, the following permissions are required: + +### Create +
+apigateway:PUT,
+apigateway:GET,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +rest_api_id, +resource_id, +http_method +FROM awscc.apigateway.methods +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/model/index.md b/docs/awscc-docs/providers/awscc/apigateway/model/index.md new file mode 100644 index 0000000000..6dcd23b236 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/model/index.md @@ -0,0 +1,74 @@ +--- +title: model +hide_title: false +hide_table_of_contents: false +keywords: + - model + - 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 +--- +Gets an individual model resource + +## Overview + + + + + +
Namemodel
TypeResource
Descriptionmodel
Idawscc.apigateway.model
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
content_typestringThe content-type for the model.
descriptionstringThe description of the model.
namestringA 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).<br/> 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.
rest_api_idstringThe string identifier of the associated RestApi.
schemaobjectThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:PATCH,
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +content_type, +description, +name, +rest_api_id, +schema +FROM awscc.apigateway.model +WHERE region = 'us-east-1' +AND data__Identifier = '<RestApiId>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/models/index.md b/docs/awscc-docs/providers/awscc/apigateway/models/index.md new file mode 100644 index 0000000000..bb9740f37a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/models/index.md @@ -0,0 +1,61 @@ +--- +title: models +hide_title: false +hide_table_of_contents: false +keywords: + - models + - 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 +--- +Retrieves a list of models in a region + +## Overview + + + + + +
Namemodels
TypeResource
Descriptionmodels
Idawscc.apigateway.models
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
namestringA 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).<br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the models resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +rest_api_id, +name +FROM awscc.apigateway.models +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md b/docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md new file mode 100644 index 0000000000..826cd0e62f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md @@ -0,0 +1,73 @@ +--- +title: request_validator +hide_title: false +hide_table_of_contents: false +keywords: + - request_validator + - 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 +--- +Gets an individual request_validator resource + +## Overview + + + + + +
Namerequest_validator
TypeResource
Descriptionrequest_validator
Idawscc.apigateway.request_validator
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
request_validator_idstring
namestringThe name of this RequestValidator
rest_api_idstringThe string identifier of the associated RestApi.
validate_request_bodybooleanA Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validate_request_parametersbooleanA Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the request_validator resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET
+ +### Delete +
+apigateway:DELETE
+ +### Read +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +request_validator_id, +name, +rest_api_id, +validate_request_body, +validate_request_parameters +FROM awscc.apigateway.request_validator +WHERE region = 'us-east-1' +AND data__Identifier = '<RestApiId>' +AND data__Identifier = '<RequestValidatorId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md b/docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md new file mode 100644 index 0000000000..572f6a0dfd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md @@ -0,0 +1,61 @@ +--- +title: request_validators +hide_title: false +hide_table_of_contents: false +keywords: + - request_validators + - 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 +--- +Retrieves a list of request_validators in a region + +## Overview + + + + + +
Namerequest_validators
TypeResource
Descriptionrequest_validators
Idawscc.apigateway.request_validators
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
request_validator_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the request_validators resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +rest_api_id, +request_validator_id +FROM awscc.apigateway.request_validators +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/resource/index.md b/docs/awscc-docs/providers/awscc/apigateway/resource/index.md new file mode 100644 index 0000000000..a6e2818e87 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/resource/index.md @@ -0,0 +1,71 @@ +--- +title: resource +hide_title: false +hide_table_of_contents: false +keywords: + - resource + - 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 +--- +Gets an individual resource resource + +## Overview + + + + + +
Nameresource
TypeResource
Descriptionresource
Idawscc.apigateway.resource
+ +## Fields + + + + + + + + +
NameDatatypeDescription
resource_idstring
rest_api_idstringThe string identifier of the associated RestApi.
parent_idstringThe parent resource's identifier.
path_partstringThe last path segment for this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:PATCH
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +resource_id, +rest_api_id, +parent_id, +path_part +FROM awscc.apigateway.resource +WHERE region = 'us-east-1' +AND data__Identifier = '<RestApiId>' +AND data__Identifier = '<ResourceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/resources/index.md b/docs/awscc-docs/providers/awscc/apigateway/resources/index.md new file mode 100644 index 0000000000..f6ee0fea2e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/resources/index.md @@ -0,0 +1,60 @@ +--- +title: resources +hide_title: false +hide_table_of_contents: false +keywords: + - resources + - 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 +--- +Retrieves a list of resources in a region + +## Overview + + + + + +
Nameresources
TypeResource
Descriptionresources
Idawscc.apigateway.resources
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
resource_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resources resource, the following permissions are required: + +### Create +
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +rest_api_id, +resource_id +FROM awscc.apigateway.resources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md b/docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md new file mode 100644 index 0000000000..9ab9a33122 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md @@ -0,0 +1,101 @@ +--- +title: rest_api +hide_title: false +hide_table_of_contents: false +keywords: + - rest_api + - 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 +--- +Gets an individual rest_api resource + +## Overview + + + + + +
Namerest_api
TypeResource
Descriptionrest_api
Idawscc.apigateway.rest_api
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
rest_api_idstring
root_resource_idstring
api_key_source_typestringThe 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.
binary_media_typesarrayThe list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
bodyobjectAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
body_s3_locationobjectThe 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.
clone_fromstringThe ID of the RestApi that you want to clone from.
endpoint_configurationobjectA 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.
descriptionstringThe description of the RestApi.
disable_execute_api_endpointbooleanSpecifies 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
fail_on_warningsbooleanA query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.
namestringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
minimum_compression_sizeintegerA 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.
modestringThis property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.<br/> Valid values are ``overwrite`` or ``merge``. <br/> For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.<br/> For ``merge``, the new API definition is merged with the existing API.<br/> 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. <br/> 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.
policyobjectA 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 ``"*"``.
parametersobjectCustom 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'``.
tagsarrayThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rest_api resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:DELETE,
+apigateway:PATCH,
+apigateway:PUT,
+apigateway:UpdateRestApiPolicy,
+s3:GetObject,
+iam:PassRole
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +rest_api_id, +root_resource_id, +api_key_source_type, +binary_media_types, +body, +body_s3_location, +clone_from, +endpoint_configuration, +description, +disable_execute_api_endpoint, +fail_on_warnings, +name, +minimum_compression_size, +mode, +policy, +parameters, +tags +FROM awscc.apigateway.rest_api +WHERE region = 'us-east-1' +AND data__Identifier = '<RestApiId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md b/docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md new file mode 100644 index 0000000000..d0173b3131 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md @@ -0,0 +1,64 @@ +--- +title: rest_apis +hide_title: false +hide_table_of_contents: false +keywords: + - rest_apis + - 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 +--- +Retrieves a list of rest_apis in a region + +## Overview + + + + + +
Namerest_apis
TypeResource
Descriptionrest_apis
Idawscc.apigateway.rest_apis
+ +## Fields + + + + + +
NameDatatypeDescription
rest_api_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rest_apis resource, the following permissions are required: + +### Create +
+apigateway:GET,
+apigateway:POST,
+apigateway:PUT,
+apigateway:PATCH,
+apigateway:UpdateRestApiPolicy,
+s3:GetObject,
+iam:PassRole
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +rest_api_id +FROM awscc.apigateway.rest_apis +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/stage/index.md b/docs/awscc-docs/providers/awscc/apigateway/stage/index.md new file mode 100644 index 0000000000..12e09dc2b8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/stage/index.md @@ -0,0 +1,93 @@ +--- +title: stage +hide_title: false +hide_table_of_contents: false +keywords: + - stage + - 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 +--- +Gets an individual stage resource + +## Overview + + + + + +
Namestage
TypeResource
Descriptionstage
Idawscc.apigateway.stage
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
access_log_settingobjectAccess log settings, including the access log format and access log destination ARN.
cache_cluster_enabledbooleanSpecifies whether a cache cluster is enabled for the stage.
cache_cluster_sizestringThe 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).
canary_settingobjectSettings for the canary deployment in this stage.
client_certificate_idstringThe identifier of a client certificate for an API stage.
deployment_idstringThe identifier of the Deployment that the stage points to.
descriptionstringThe stage's description.
documentation_versionstringThe version of the associated API documentation.
method_settingsarrayA 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.
rest_api_idstringThe string identifier of the associated RestApi.
stage_namestringThe 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.
tagsarrayThe collection of tags. Each tag element is associated with a given resource.
tracing_enabledbooleanSpecifies whether active tracing with X-ray is enabled for the Stage.
variablesobjectA 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-._~:/?#&=,]+``.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stage resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:PATCH,
+apigateway:PUT,
+apigateway:DELETE
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```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, +tags, +tracing_enabled, +variables +FROM awscc.apigateway.stage +WHERE region = 'us-east-1' +AND data__Identifier = '<RestApiId>' +AND data__Identifier = '<StageName>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/stages/index.md b/docs/awscc-docs/providers/awscc/apigateway/stages/index.md new file mode 100644 index 0000000000..60cfdf4fa4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/stages/index.md @@ -0,0 +1,63 @@ +--- +title: stages +hide_title: false +hide_table_of_contents: false +keywords: + - stages + - 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 +--- +Retrieves a list of stages in a region + +## Overview + + + + + +
Namestages
TypeResource
Descriptionstages
Idawscc.apigateway.stages
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
stage_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stages resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +rest_api_id, +stage_name +FROM awscc.apigateway.stages +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md b/docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md new file mode 100644 index 0000000000..953336ab5e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md @@ -0,0 +1,80 @@ +--- +title: usage_plan +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plan + - 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 +--- +Gets an individual usage_plan resource + +## Overview + + + + + +
Nameusage_plan
TypeResource
Descriptionusage_plan
Idawscc.apigateway.usage_plan
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
api_stagesarrayThe associated API stages of a usage plan.
descriptionstringThe description of a usage plan.
quotaobjectThe target maximum number of permitted requests per a given unit time interval.
tagsarrayThe collection of tags. Each tag element is associated with a given resource.
throttleobjectA map containing method level throttling information for API stage in a usage plan.
usage_plan_namestringThe name of a usage plan.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the usage_plan resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:GET,
+apigateway:DELETE,
+apigateway:PATCH,
+apigateway:PUT
+ +### Delete +
+apigateway:DELETE,
+apigateway:GET,
+apigateway:PATCH
+ + +## Example +```sql +SELECT +region, +id, +api_stages, +description, +quota, +tags, +throttle, +usage_plan_name +FROM awscc.apigateway.usage_plan +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/usage_plan_key/index.md b/docs/awscc-docs/providers/awscc/apigateway/usage_plan_key/index.md new file mode 100644 index 0000000000..108bb5b6ef --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/usage_plan_key/index.md @@ -0,0 +1,66 @@ +--- +title: usage_plan_key +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plan_key + - 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 +--- +Gets an individual usage_plan_key resource + +## Overview + + + + + +
Nameusage_plan_key
TypeResource
Descriptionusage_plan_key
Idawscc.apigateway.usage_plan_key
+ +## Fields + + + + + + + + +
NameDatatypeDescription
key_idstringThe Id of the UsagePlanKey resource.
key_typestringThe type of a UsagePlanKey resource for a plan customer.
usage_plan_idstringThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the usage_plan_key resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:DELETE,
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +key_id, +key_type, +usage_plan_id, +id +FROM awscc.apigateway.usage_plan_key +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/usage_plan_keys/index.md b/docs/awscc-docs/providers/awscc/apigateway/usage_plan_keys/index.md new file mode 100644 index 0000000000..54bcbe6585 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/usage_plan_keys/index.md @@ -0,0 +1,59 @@ +--- +title: usage_plan_keys +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plan_keys + - 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 +--- +Retrieves a list of usage_plan_keys in a region + +## Overview + + + + + +
Nameusage_plan_keys
TypeResource
Descriptionusage_plan_keys
Idawscc.apigateway.usage_plan_keys
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the usage_plan_keys resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.apigateway.usage_plan_keys +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md b/docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md new file mode 100644 index 0000000000..4afdd7b702 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md @@ -0,0 +1,60 @@ +--- +title: usage_plans +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plans + - 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 +--- +Retrieves a list of usage_plans in a region + +## Overview + + + + + +
Nameusage_plans
TypeResource
Descriptionusage_plans
Idawscc.apigateway.usage_plans
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the usage_plans resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET,
+apigateway:PUT
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.apigateway.usage_plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md b/docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md new file mode 100644 index 0000000000..17388e3538 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md @@ -0,0 +1,87 @@ +--- +title: vpc_link +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_link + - 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 +--- +Gets an individual vpc_link resource + +## Overview + + + + + +
Namevpc_link
TypeResource
Descriptionvpc_link
Idawscc.apigateway.vpc_link
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringA name for the VPC link.
descriptionstringA description of the VPC link.
tagsarrayAn array of arbitrary tags (key-value pairs) to associate with the stage.
target_arnsarrayThe ARN of 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.
vpc_link_idstringThe ID of the instance that backs VPC link.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_link resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT,
+ec2:CreateVpcEndpointServiceConfiguration,
+ec2:DeleteVpcEndpointServiceConfigurations,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:ModifyVpcEndpointServicePermissions
+ +### Read +
+apigateway:GET,
+ec2:CreateVpcEndpointServiceConfiguration,
+ec2:DeleteVpcEndpointServiceConfigurations,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:ModifyVpcEndpointServicePermissions
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE,
+apigateway:PUT,
+ec2:CreateVpcEndpointServiceConfiguration,
+ec2:DeleteVpcEndpointServiceConfigurations,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:ModifyVpcEndpointServicePermissions
+ + +## Example +```sql +SELECT +region, +name, +description, +tags, +target_arns, +vpc_link_id +FROM awscc.apigateway.vpc_link +WHERE region = 'us-east-1' +AND data__Identifier = '<VpcLinkId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md b/docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md new file mode 100644 index 0000000000..63b85216bc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md @@ -0,0 +1,68 @@ +--- +title: vpc_links +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_links + - 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 +--- +Retrieves a list of vpc_links in a region + +## Overview + + + + + +
Namevpc_links
TypeResource
Descriptionvpc_links
Idawscc.apigateway.vpc_links
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_link_idstringThe ID of the instance that backs VPC link.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_links resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:PUT,
+apigateway:GET,
+ec2:CreateVpcEndpointServiceConfiguration,
+ec2:DeleteVpcEndpointServiceConfigurations,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:ModifyVpcEndpointServicePermissions
+ +### List +
+apigateway:GET,
+ec2:CreateVpcEndpointServiceConfiguration,
+ec2:DeleteVpcEndpointServiceConfigurations,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:ModifyVpcEndpointServicePermissions
+ + +## Example +```sql +SELECT +region, +vpc_link_id +FROM awscc.apigateway.vpc_links +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md new file mode 100644 index 0000000000..bda688222e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md @@ -0,0 +1,106 @@ +--- +title: api +hide_title: false +hide_table_of_contents: false +keywords: + - api + - 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 +--- +Gets an individual api resource + +## Overview + + + + + +
Nameapi
TypeResource
Descriptionapi
Idawscc.apigatewayv2.api
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
route_selection_expressionstringThe 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.
body_s3_locationobjectThe 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.
descriptionstringThe description of the API.
api_endpointstring
base_pathstringSpecifies 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.
fail_on_warningsbooleanSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
disable_execute_api_endpointbooleanSpecifies 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.
disable_schema_validationbooleanAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
namestringThe name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.
targetstringThis 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.
credentials_arnstringThis 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.
cors_configurationobjectA 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.
versionstringA version identifier for the API.
protocol_typestringThe API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.
route_keystringThis 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.
api_idstring
bodyobjectThe 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.
tagsobjectThe collection of tags. Each tag element is associated with a given resource.
api_key_selection_expressionstringAn 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).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT,
+apigateway:POST,
+s3:getObject
+ +### Read +
+apigateway:GET,
+s3:getObject
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE,
+s3:getObject
+ + +## Example +```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, +tags, +api_key_selection_expression +FROM awscc.apigatewayv2.api +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md new file mode 100644 index 0000000000..e1f3c7166c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md @@ -0,0 +1,74 @@ +--- +title: api_mapping +hide_title: false +hide_table_of_contents: false +keywords: + - api_mapping + - 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 +--- +Gets an individual api_mapping resource + +## Overview + + + + + +
Nameapi_mapping
TypeResource
Descriptionapi_mapping
Idawscc.apigatewayv2.api_mapping
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
api_mapping_idstring
domain_namestringThe domain name.
stagestringThe API stage.
api_mapping_keystringThe API mapping key.
api_idstringThe identifier of the API.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_mapping resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT
+ +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +api_mapping_id, +domain_name, +stage, +api_mapping_key, +api_id +FROM awscc.apigatewayv2.api_mapping +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiMappingId>' +AND data__Identifier = '<DomainName>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md new file mode 100644 index 0000000000..5f20d005e0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md @@ -0,0 +1,60 @@ +--- +title: api_mappings +hide_title: false +hide_table_of_contents: false +keywords: + - api_mappings + - 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 +--- +Retrieves a list of api_mappings in a region + +## Overview + + + + + +
Nameapi_mappings
TypeResource
Descriptionapi_mappings
Idawscc.apigatewayv2.api_mappings
+ +## Fields + + + + + + +
NameDatatypeDescription
api_mapping_idstring
domain_namestringThe domain name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_mappings resource, the following permissions are required: + +### Create +
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +api_mapping_id, +domain_name +FROM awscc.apigatewayv2.api_mappings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md new file mode 100644 index 0000000000..04ed3ee583 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md @@ -0,0 +1,61 @@ +--- +title: apis +hide_title: false +hide_table_of_contents: false +keywords: + - apis + - 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 +--- +Retrieves a list of apis in a region + +## Overview + + + + + +
Nameapis
TypeResource
Descriptionapis
Idawscc.apigatewayv2.apis
+ +## Fields + + + + + +
NameDatatypeDescription
api_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the apis resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:PUT,
+s3:getObject
+ +### List +
+apigateway:GET,
+s3:getObject
+ + +## Example +```sql +SELECT +region, +api_id +FROM awscc.apigatewayv2.apis +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md new file mode 100644 index 0000000000..cc73f4e6a4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md @@ -0,0 +1,90 @@ +--- +title: authorizer +hide_title: false +hide_table_of_contents: false +keywords: + - authorizer + - 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 +--- +Gets an individual authorizer resource + +## Overview + + + + + +
Nameauthorizer
TypeResource
Descriptionauthorizer
Idawscc.apigatewayv2.authorizer
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
identity_validation_expressionstringThis parameter is not used.
authorizer_uristringThe 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``.
authorizer_credentials_arnstringSpecifies 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.
authorizer_typestringThe authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).
jwt_configurationobjectThe ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.
authorizer_result_ttl_in_secondsintegerThe 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.
identity_sourcearrayThe identity source for which authorization is requested.<br/> 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).<br/> 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``.
authorizer_payload_format_versionstringSpecifies 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).
api_idstringThe API identifier.
enable_simple_responsesbooleanSpecifies 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).
authorizer_idstring
namestringThe name of the authorizer.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the authorizer resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT,
+iam:PassRole
+ +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```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, +name +FROM awscc.apigatewayv2.authorizer +WHERE region = 'us-east-1' +AND data__Identifier = '<AuthorizerId>' +AND data__Identifier = '<ApiId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md new file mode 100644 index 0000000000..9f90e3a0d8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md @@ -0,0 +1,61 @@ +--- +title: authorizers +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers + - 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 +--- +Retrieves a list of authorizers in a region + +## Overview + + + + + +
Nameauthorizers
TypeResource
Descriptionauthorizers
Idawscc.apigatewayv2.authorizers
+ +## Fields + + + + + + +
NameDatatypeDescription
authorizer_idstring
api_idstringThe API identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +
+apigateway:POST,
+iam:PassRole
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +authorizer_id, +api_id +FROM awscc.apigatewayv2.authorizers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md new file mode 100644 index 0000000000..8028335545 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md @@ -0,0 +1,73 @@ +--- +title: deployment +hide_title: false +hide_table_of_contents: false +keywords: + - deployment + - 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 +--- +Gets an individual deployment resource + +## Overview + + + + + +
Namedeployment
TypeResource
Descriptiondeployment
Idawscc.apigatewayv2.deployment
+ +## Fields + + + + + + + + +
NameDatatypeDescription
deployment_idstring
descriptionstringThe description for the deployment resource.
stage_namestringThe name of an existing stage to associate with the deployment.
api_idstringThe API identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployment resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT
+ +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +deployment_id, +description, +stage_name, +api_id +FROM awscc.apigatewayv2.deployment +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiId>' +AND data__Identifier = '<DeploymentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md new file mode 100644 index 0000000000..73cfe3b098 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md @@ -0,0 +1,60 @@ +--- +title: deployments +hide_title: false +hide_table_of_contents: false +keywords: + - deployments + - 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 +--- +Retrieves a list of deployments in a region + +## Overview + + + + + +
Namedeployments
TypeResource
Descriptiondeployments
Idawscc.apigatewayv2.deployments
+ +## Fields + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
deployment_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +api_id, +deployment_id +FROM awscc.apigatewayv2.deployments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md new file mode 100644 index 0000000000..7033b501b1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md @@ -0,0 +1,76 @@ +--- +title: domain_name +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name + - 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 +--- +Gets an individual domain_name resource + +## Overview + + + + + +
Namedomain_name
TypeResource
Descriptiondomain_name
Idawscc.apigatewayv2.domain_name
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
mutual_tls_authenticationobjectThe mutual TLS authentication configuration for a custom domain name.
regional_hosted_zone_idstring
regional_domain_namestring
domain_namestringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
domain_name_configurationsarrayThe domain name configurations.
tagsobjectThe collection of tags associated with a domain name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_name resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT
+ +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +mutual_tls_authentication, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +domain_name_configurations, +tags +FROM awscc.apigatewayv2.domain_name +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md new file mode 100644 index 0000000000..7221154281 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md @@ -0,0 +1,60 @@ +--- +title: domain_names +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names + - 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 +--- +Retrieves a list of domain_names in a region + +## Overview + + + + + +
Namedomain_names
TypeResource
Descriptiondomain_names
Idawscc.apigatewayv2.domain_names
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_names resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET,
+apigateway:PUT
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +domain_name +FROM awscc.apigatewayv2.domain_names +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/index.md new file mode 100644 index 0000000000..56a49f1537 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/index.md @@ -0,0 +1,57 @@ +--- +title: apigatewayv2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The apigatewayv2 service documentation. + +:::info Service Summary + +
+
+total resources: 20
+total selectable resources: 20
+total methods: 20
+
+
+ +::: + +## Resources +
+
+api
+api_mapping
+api_mappings
+apis
+authorizer
+authorizers
+deployment
+deployments
+domain_name
+domain_names +
+
+integration_response
+integration_responses
+model
+models
+route
+route_response
+route_responses
+routes
+vpc_link
+vpc_links +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/integration_response/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/integration_response/index.md new file mode 100644 index 0000000000..ca3dd623b2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/integration_response/index.md @@ -0,0 +1,82 @@ +--- +title: integration_response +hide_title: false +hide_table_of_contents: false +keywords: + - integration_response + - 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 +--- +Gets an individual integration_response resource + +## Overview + + + + + +
Nameintegration_response
TypeResource
Descriptionintegration_response
Idawscc.apigatewayv2.integration_response
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
integration_response_idstring
response_templatesobjectThe 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.
template_selection_expressionstringThe template selection expression for the integration response. Supported only for WebSocket APIs.
response_parametersobjectA 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.
content_handling_strategystringSupported 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:<br/> ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.<br/> ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.<br/> 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.
integration_idstringThe integration ID.
integration_response_keystringThe integration response key.
api_idstringThe API identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integration_response resource, the following permissions are required: + +### Read +
+apigateway:GET
+ +### Update +
+apigateway:PATCH,
+apigateway:PUT,
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +integration_response_id, +response_templates, +template_selection_expression, +response_parameters, +content_handling_strategy, +integration_id, +integration_response_key, +api_id +FROM awscc.apigatewayv2.integration_response +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiId>' +AND data__Identifier = '<IntegrationId>' +AND data__Identifier = '<IntegrationResponseId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md new file mode 100644 index 0000000000..453c4c8718 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md @@ -0,0 +1,62 @@ +--- +title: integration_responses +hide_title: false +hide_table_of_contents: false +keywords: + - integration_responses + - 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 +--- +Retrieves a list of integration_responses in a region + +## Overview + + + + + +
Nameintegration_responses
TypeResource
Descriptionintegration_responses
Idawscc.apigatewayv2.integration_responses
+ +## Fields + + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
integration_idstringThe integration ID.
integration_response_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integration_responses resource, the following permissions are required: + +### Create +
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +api_id, +integration_id, +integration_response_id +FROM awscc.apigatewayv2.integration_responses +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md new file mode 100644 index 0000000000..ba15b685dc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md @@ -0,0 +1,77 @@ +--- +title: model +hide_title: false +hide_table_of_contents: false +keywords: + - model + - 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 +--- +Gets an individual model resource + +## Overview + + + + + +
Namemodel
TypeResource
Descriptionmodel
Idawscc.apigatewayv2.model
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
model_idstring
descriptionstringThe description of the model.
content_typestringThe content-type for the model, for example, "application/json".
schemaobjectThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
api_idstringThe API identifier.
namestringThe name of the model.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT
+ +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +model_id, +description, +content_type, +schema, +api_id, +name +FROM awscc.apigatewayv2.model +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiId>' +AND data__Identifier = '<ModelId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md new file mode 100644 index 0000000000..fce47acbda --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md @@ -0,0 +1,60 @@ +--- +title: models +hide_title: false +hide_table_of_contents: false +keywords: + - models + - 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 +--- +Retrieves a list of models in a region + +## Overview + + + + + +
Namemodels
TypeResource
Descriptionmodels
Idawscc.apigatewayv2.models
+ +## Fields + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
model_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the models resource, the following permissions are required: + +### Create +
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +api_id, +model_id +FROM awscc.apigatewayv2.models +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md new file mode 100644 index 0000000000..0e065f29ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md @@ -0,0 +1,91 @@ +--- +title: route +hide_title: false +hide_table_of_contents: false +keywords: + - route + - 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 +--- +Gets an individual route resource + +## Overview + + + + + +
Nameroute
TypeResource
Descriptionroute
Idawscc.apigatewayv2.route
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
route_idstring
route_response_selection_expressionstringThe route response selection expression for the route. Supported only for WebSocket APIs.
request_modelsobjectThe request models for the route. Supported only for WebSocket APIs.
operation_namestringThe operation name for the route.
authorization_scopesarrayThe authorization scopes supported by this route.
api_key_requiredbooleanSpecifies whether an API key is required for the route. Supported only for WebSocket APIs.
route_keystringThe 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``.
authorization_typestringThe 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.
model_selection_expressionstringThe model selection expression for the route. Supported only for WebSocket APIs.
api_idstringThe API identifier.
request_parametersobjectThe request parameters for the route. Supported only for WebSocket APIs.
targetstringThe target for the route.
authorizer_idstringThe identifier of the ``Authorizer`` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the route resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT
+ +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```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, +request_parameters, +target, +authorizer_id +FROM awscc.apigatewayv2.route +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiId>' +AND data__Identifier = '<RouteId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md new file mode 100644 index 0000000000..2bd35c6e41 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md @@ -0,0 +1,80 @@ +--- +title: route_response +hide_title: false +hide_table_of_contents: false +keywords: + - route_response + - 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 +--- +Gets an individual route_response resource + +## Overview + + + + + +
Nameroute_response
TypeResource
Descriptionroute_response
Idawscc.apigatewayv2.route_response
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
route_response_keystringThe route response key.
response_parametersundefinedThe route response parameters.
route_idstringThe route ID.
model_selection_expressionstringThe model selection expression for the route response. Supported only for WebSocket APIs.
api_idstringThe API identifier.
response_modelsobjectThe response models for the route response.
route_response_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the route_response resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:PUT
+ +### Read +
+apigateway:GET
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE
+ + +## Example +```sql +SELECT +region, +route_response_key, +response_parameters, +route_id, +model_selection_expression, +api_id, +response_models, +route_response_id +FROM awscc.apigatewayv2.route_response +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiId>' +AND data__Identifier = '<RouteId>' +AND data__Identifier = '<RouteResponseId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md new file mode 100644 index 0000000000..85b36147dd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md @@ -0,0 +1,62 @@ +--- +title: route_responses +hide_title: false +hide_table_of_contents: false +keywords: + - route_responses + - 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 +--- +Retrieves a list of route_responses in a region + +## Overview + + + + + +
Nameroute_responses
TypeResource
Descriptionroute_responses
Idawscc.apigatewayv2.route_responses
+ +## Fields + + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
route_idstringThe route ID.
route_response_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the route_responses resource, the following permissions are required: + +### Create +
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +api_id, +route_id, +route_response_id +FROM awscc.apigatewayv2.route_responses +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md new file mode 100644 index 0000000000..a5412916b2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md @@ -0,0 +1,60 @@ +--- +title: routes +hide_title: false +hide_table_of_contents: false +keywords: + - routes + - 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 +--- +Retrieves a list of routes in a region + +## Overview + + + + + +
Nameroutes
TypeResource
Descriptionroutes
Idawscc.apigatewayv2.routes
+ +## Fields + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
route_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the routes resource, the following permissions are required: + +### Create +
+apigateway:POST
+ +### List +
+apigateway:GET
+ + +## Example +```sql +SELECT +region, +api_id, +route_id +FROM awscc.apigatewayv2.routes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md new file mode 100644 index 0000000000..aace2340ee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md @@ -0,0 +1,84 @@ +--- +title: vpc_link +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_link + - 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 +--- +Gets an individual vpc_link resource + +## Overview + + + + + +
Namevpc_link
TypeResource
Descriptionvpc_link
Idawscc.apigatewayv2.vpc_link
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
vpc_link_idstring
subnet_idsarrayA list of subnet IDs to include in the VPC link.
security_group_idsarrayA list of security group IDs for the VPC link.
tagsobjectThe collection of tags. Each tag element is associated with a given resource.
namestringThe name of the VPC link.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_link resource, the following permissions are required: + +### Update +
+apigateway:PATCH,
+apigateway:GET,
+apigateway:TagResource,
+apigateway:unTagResource,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### Read +
+apigateway:GET,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### Delete +
+apigateway:GET,
+apigateway:DELETE,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ + +## Example +```sql +SELECT +region, +vpc_link_id, +subnet_ids, +security_group_ids, +tags, +name +FROM awscc.apigatewayv2.vpc_link +WHERE region = 'us-east-1' +AND data__Identifier = '<VpcLinkId>' +``` diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md new file mode 100644 index 0000000000..3b15aec0ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md @@ -0,0 +1,66 @@ +--- +title: vpc_links +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_links + - 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 +--- +Retrieves a list of vpc_links in a region + +## Overview + + + + + +
Namevpc_links
TypeResource
Descriptionvpc_links
Idawscc.apigatewayv2.vpc_links
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_link_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_links resource, the following permissions are required: + +### Create +
+apigateway:POST,
+apigateway:GET,
+apigateway:TagResource,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### List +
+apigateway:GET,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ + +## Example +```sql +SELECT +region, +vpc_link_id +FROM awscc.apigatewayv2.vpc_links +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/application/index.md b/docs/awscc-docs/providers/awscc/appconfig/application/index.md new file mode 100644 index 0000000000..99b3ed0acb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/application/index.md @@ -0,0 +1,73 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.appconfig.application
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringA description of the application.
application_idstringThe application Id
tagsarrayMetadata 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.
namestringA name for the application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+appconfig:GetApplication,
+appconfig:ListTagsForResource
+ +### Update +
+appconfig:UpdateApplication,
+appconfig:TagResource,
+appconfig:UntagResource
+ +### Delete +
+appconfig:GetApplication,
+appconfig:DeleteApplication
+ + +## Example +```sql +SELECT +region, +description, +application_id, +tags, +name +FROM awscc.appconfig.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/applications/index.md b/docs/awscc-docs/providers/awscc/appconfig/applications/index.md new file mode 100644 index 0000000000..df729dc2c4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/applications/index.md @@ -0,0 +1,61 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.appconfig.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_idstringThe application Id
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+appconfig:CreateApplication,
+appconfig:GetApplication,
+appconfig:ListTagsForResource,
+appconfig:TagResource
+ +### List +
+appconfig:ListApplications
+ + +## Example +```sql +SELECT +region, +application_id +FROM awscc.appconfig.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md b/docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md new file mode 100644 index 0000000000..5920703ff1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md @@ -0,0 +1,88 @@ +--- +title: configuration_profile +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_profile + - 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 +--- +Gets an individual configuration_profile resource + +## Overview + + + + + +
Nameconfiguration_profile
TypeResource
Descriptionconfiguration_profile
Idawscc.appconfig.configuration_profile
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
location_uristringA 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.
typestringThe type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
descriptionstringA description of the configuration profile.
validatorsarrayA list of methods for validating the configuration.
retrieval_role_arnstringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri.
configuration_profile_idstringThe configuration profile ID
application_idstringThe application ID.
tagsarrayMetadata 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.
namestringA name for the configuration profile.
kms_key_identifierstringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
kms_key_arnstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_profile resource, the following permissions are required: + +### Read +
+appconfig:GetConfigurationProfile,
+appconfig:ListTagsForResource
+ +### Update +
+appconfig:UpdateConfigurationProfile,
+appconfig:TagResource,
+appconfig:UntagResource,
+iam:PassRole
+ +### Delete +
+appconfig:DeleteConfigurationProfile
+ + +## Example +```sql +SELECT +region, +location_uri, +type, +description, +validators, +retrieval_role_arn, +configuration_profile_id, +application_id, +tags, +name, +kms_key_identifier, +kms_key_arn +FROM awscc.appconfig.configuration_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationId>' +AND data__Identifier = '<ConfigurationProfileId>' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md b/docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md new file mode 100644 index 0000000000..be1fd28ea2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md @@ -0,0 +1,64 @@ +--- +title: configuration_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_profiles + - 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 +--- +Retrieves a list of configuration_profiles in a region + +## Overview + + + + + +
Nameconfiguration_profiles
TypeResource
Descriptionconfiguration_profiles
Idawscc.appconfig.configuration_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
application_idstringThe application ID.
configuration_profile_idstringThe configuration profile ID
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_profiles resource, the following permissions are required: + +### Create +
+appconfig:CreateConfigurationProfile,
+appconfig:GetConfigurationProfile,
+appconfig:TagResource,
+appconfig:ListTagsForResource,
+iam:PassRole
+ +### List +
+appconfig:ListConfigurationProfiles
+ + +## Example +```sql +SELECT +region, +application_id, +configuration_profile_id +FROM awscc.appconfig.configuration_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/environment/index.md b/docs/awscc-docs/providers/awscc/appconfig/environment/index.md new file mode 100644 index 0000000000..9b3a62e1c9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/environment/index.md @@ -0,0 +1,79 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.appconfig.environment
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
environment_idstringThe environment ID.
application_idstringThe application ID.
namestringA name for the environment.
descriptionstringA description of the environment.
monitorsarrayAmazon CloudWatch alarms to monitor during the deployment process.
tagsarrayMetadata 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+appconfig:GetEnvironment,
+appconfig:ListTagsForResource
+ +### Update +
+appconfig:UpdateEnvironment,
+appconfig:TagResource,
+appconfig:UntagResource,
+iam:PassRole
+ +### Delete +
+appconfig:GetEnvironment,
+appconfig:DeleteEnvironment
+ + +## Example +```sql +SELECT +region, +environment_id, +application_id, +name, +description, +monitors, +tags +FROM awscc.appconfig.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationId>' +AND data__Identifier = '<EnvironmentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/environments/index.md b/docs/awscc-docs/providers/awscc/appconfig/environments/index.md new file mode 100644 index 0000000000..6273f4a676 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/environments/index.md @@ -0,0 +1,64 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.appconfig.environments
+ +## Fields + + + + + + +
NameDatatypeDescription
application_idstringThe application ID.
environment_idstringThe environment ID.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+appconfig:CreateEnvironment,
+appconfig:GetEnvironment,
+appconfig:ListTagsForResource,
+appconfig:TagResource,
+iam:PassRole
+ +### List +
+appconfig:ListEnvironments
+ + +## Example +```sql +SELECT +region, +application_id, +environment_id +FROM awscc.appconfig.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/extension/index.md b/docs/awscc-docs/providers/awscc/appconfig/extension/index.md new file mode 100644 index 0000000000..96a26ad9f7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/extension/index.md @@ -0,0 +1,82 @@ +--- +title: extension +hide_title: false +hide_table_of_contents: false +keywords: + - extension + - 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 +--- +Gets an individual extension resource + +## Overview + + + + + +
Nameextension
TypeResource
Descriptionextension
Idawscc.appconfig.extension
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
version_numberinteger
namestringName of the extension.
descriptionstringDescription of the extension.
actionsobject
parametersobject
latest_version_numberinteger
tagsarrayAn array of key-value tags to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the extension resource, the following permissions are required: + +### Read +
+appconfig:GetExtension
+ +### Update +
+appconfig:UpdateExtension,
+appconfig:TagResource,
+appconfig:UntagResource
+ +### Delete +
+appconfig:DeleteExtension,
+appconfig:UntagResource
+ + +## Example +```sql +SELECT +region, +id, +arn, +version_number, +name, +description, +actions, +parameters, +latest_version_number, +tags +FROM awscc.appconfig.extension +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md b/docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md new file mode 100644 index 0000000000..80441c8e19 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md @@ -0,0 +1,82 @@ +--- +title: extension_association +hide_title: false +hide_table_of_contents: false +keywords: + - extension_association + - 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 +--- +Gets an individual extension_association resource + +## Overview + + + + + +
Nameextension_association
TypeResource
Descriptionextension_association
Idawscc.appconfig.extension_association
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
extension_arnstring
resource_arnstring
extension_identifierstring
resource_identifierstring
extension_version_numberinteger
parametersobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the extension_association resource, the following permissions are required: + +### Read +
+appconfig:GetExtensionAssociation
+ +### Update +
+appconfig:UpdateExtensionAssociation,
+appconfig:TagResource,
+appconfig:UntagResource
+ +### Delete +
+appconfig:DeleteExtensionAssociation,
+appconfig:UntagResource
+ + +## Example +```sql +SELECT +region, +id, +arn, +extension_arn, +resource_arn, +extension_identifier, +resource_identifier, +extension_version_number, +parameters, +tags +FROM awscc.appconfig.extension_association +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md b/docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md new file mode 100644 index 0000000000..c8ee88d8a5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md @@ -0,0 +1,59 @@ +--- +title: extension_associations +hide_title: false +hide_table_of_contents: false +keywords: + - extension_associations + - 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 +--- +Retrieves a list of extension_associations in a region + +## Overview + + + + + +
Nameextension_associations
TypeResource
Descriptionextension_associations
Idawscc.appconfig.extension_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the extension_associations resource, the following permissions are required: + +### Create +
+appconfig:CreateExtensionAssociation,
+appconfig:TagResource
+ +### List +
+appconfig:ListExtensionAssociations
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.appconfig.extension_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/extensions/index.md b/docs/awscc-docs/providers/awscc/appconfig/extensions/index.md new file mode 100644 index 0000000000..fd593ec395 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/extensions/index.md @@ -0,0 +1,60 @@ +--- +title: extensions +hide_title: false +hide_table_of_contents: false +keywords: + - extensions + - 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 +--- +Retrieves a list of extensions in a region + +## Overview + + + + + +
Nameextensions
TypeResource
Descriptionextensions
Idawscc.appconfig.extensions
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the extensions resource, the following permissions are required: + +### Create +
+appconfig:CreateExtension,
+appconfig:TagResource,
+iam:PassRole
+ +### List +
+appconfig:ListExtensions
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.appconfig.extensions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_version/index.md b/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_version/index.md new file mode 100644 index 0000000000..8c98fd8011 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_version/index.md @@ -0,0 +1,75 @@ +--- +title: hosted_configuration_version +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_configuration_version + - 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 +--- +Gets an individual hosted_configuration_version resource + +## Overview + + + + + +
Namehosted_configuration_version
TypeResource
Descriptionhosted_configuration_version
Idawscc.appconfig.hosted_configuration_version
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
application_idstringThe application ID.
configuration_profile_idstringThe configuration profile ID.
version_numberstringCurrent version number of hosted configuration version.
descriptionstringA description of the hosted configuration version.
contentstringThe content of the configuration or the configuration data.
content_typestringA standard MIME type describing the format of the configuration content.
latest_version_numberintegerAn 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.
version_labelstringA user-defined label for an AWS AppConfig hosted configuration version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hosted_configuration_version resource, the following permissions are required: + +### Read +
+appconfig:GetHostedConfigurationVersion
+ +### Delete +
+appconfig:DeleteHostedConfigurationVersion
+ + +## Example +```sql +SELECT +region, +application_id, +configuration_profile_id, +version_number, +description, +content, +content_type, +latest_version_number, +version_label +FROM awscc.appconfig.hosted_configuration_version +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationId>' +AND data__Identifier = '<ConfigurationProfileId>' +AND data__Identifier = '<VersionNumber>' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_versions/index.md b/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_versions/index.md new file mode 100644 index 0000000000..5bb01ab8f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_versions/index.md @@ -0,0 +1,62 @@ +--- +title: hosted_configuration_versions +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_configuration_versions + - 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 +--- +Retrieves a list of hosted_configuration_versions in a region + +## Overview + + + + + +
Namehosted_configuration_versions
TypeResource
Descriptionhosted_configuration_versions
Idawscc.appconfig.hosted_configuration_versions
+ +## Fields + + + + + + + +
NameDatatypeDescription
application_idstringThe application ID.
configuration_profile_idstringThe configuration profile ID.
version_numberstringCurrent version number of hosted configuration version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hosted_configuration_versions resource, the following permissions are required: + +### Create +
+appconfig:CreateHostedConfigurationVersion
+ +### List +
+appconfig:ListHostedConfigurationVersions
+ + +## Example +```sql +SELECT +region, +application_id, +configuration_profile_id, +version_number +FROM awscc.appconfig.hosted_configuration_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appconfig/index.md b/docs/awscc-docs/providers/awscc/appconfig/index.md new file mode 100644 index 0000000000..fbb72f8d68 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appconfig/index.md @@ -0,0 +1,49 @@ +--- +title: appconfig +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The appconfig service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+application
+applications
+configuration_profile
+configuration_profiles
+environment
+environments +
+
+extension
+extension_association
+extension_associations
+extensions
+hosted_configuration_version
+hosted_configuration_versions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/appflow/connector/index.md b/docs/awscc-docs/providers/awscc/appflow/connector/index.md new file mode 100644 index 0000000000..7576e48249 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appflow/connector/index.md @@ -0,0 +1,72 @@ +--- +title: connector +hide_title: false +hide_table_of_contents: false +keywords: + - connector + - 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 +--- +Gets an individual connector resource + +## Overview + + + + + +
Nameconnector
TypeResource
Descriptionconnector
Idawscc.appflow.connector
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
connector_labelstring The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
connector_arnstring The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.
connector_provisioning_typestringThe provisioning type of the connector. Currently the only supported value is LAMBDA.
connector_provisioning_configobjectContains information about the configuration of the connector being registered.
descriptionstringA description about the connector that's being registered.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +
+appflow:DescribeConnector
+ +### Delete +
+appflow:UnRegisterConnector
+ +### Update +
+appflow:UpdateConnectorRegistration,
+lambda:InvokeFunction
+ + +## Example +```sql +SELECT +region, +connector_label, +connector_arn, +connector_provisioning_type, +connector_provisioning_config, +description +FROM awscc.appflow.connector +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectorLabel>' +``` diff --git a/docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md b/docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md new file mode 100644 index 0000000000..b081e2ea71 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md @@ -0,0 +1,86 @@ +--- +title: connector_profile +hide_title: false +hide_table_of_contents: false +keywords: + - connector_profile + - 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 +--- +Gets an individual connector_profile resource + +## Overview + + + + + +
Nameconnector_profile
TypeResource
Descriptionconnector_profile
Idawscc.appflow.connector_profile
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
connector_profile_arnstringUnique identifier for connector profile resources
connector_labelstringThe label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
connector_profile_namestringThe maximum number of items to retrieve in a single batch.
k_ms_arnstringThe 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.
connector_typestringList of Saas providers that need connector profile to be created
connection_modestringMode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular
connector_profile_configobjectConnector specific configurations needed to create connector profile
credentials_arnstringA unique Arn for Connector-Profile resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connector_profile resource, the following permissions are required: + +### Delete +
+appflow:DeleteConnectorProfile
+ +### Read +
+appflow:DescribeConnectorProfiles
+ +### Update +
+appflow:UpdateConnectorProfile,
+kms:ListKeys,
+kms:DescribeKey,
+kms:ListAliases,
+kms:CreateGrant,
+kms:ListGrants,
+iam:PassRole,
+secretsmanager:CreateSecret,
+secretsmanager:GetSecretValue,
+secretsmanager:PutResourcePolicy
+ + +## Example +```sql +SELECT +region, +connector_profile_arn, +connector_label, +connector_profile_name, +k_ms_arn, +connector_type, +connection_mode, +connector_profile_config, +credentials_arn +FROM awscc.appflow.connector_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectorProfileName>' +``` diff --git a/docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md b/docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md new file mode 100644 index 0000000000..a117dc339e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md @@ -0,0 +1,67 @@ +--- +title: connector_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - connector_profiles + - 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 +--- +Retrieves a list of connector_profiles in a region + +## Overview + + + + + +
Nameconnector_profiles
TypeResource
Descriptionconnector_profiles
Idawscc.appflow.connector_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
connector_profile_namestringThe maximum number of items to retrieve in a single batch.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connector_profiles resource, the following permissions are required: + +### Create +
+appflow:CreateConnectorProfile,
+kms:ListKeys,
+kms:DescribeKey,
+kms:ListAliases,
+kms:CreateGrant,
+kms:ListGrants,
+iam:PassRole,
+secretsmanager:CreateSecret,
+secretsmanager:GetSecretValue,
+secretsmanager:PutResourcePolicy
+ +### List +
+appflow:DescribeConnectorProfiles
+ + +## Example +```sql +SELECT +region, +connector_profile_name +FROM awscc.appflow.connector_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appflow/connectors/index.md b/docs/awscc-docs/providers/awscc/appflow/connectors/index.md new file mode 100644 index 0000000000..9c2b845e67 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appflow/connectors/index.md @@ -0,0 +1,59 @@ +--- +title: connectors +hide_title: false +hide_table_of_contents: false +keywords: + - connectors + - 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 +--- +Retrieves a list of connectors in a region + +## Overview + + + + + +
Nameconnectors
TypeResource
Descriptionconnectors
Idawscc.appflow.connectors
+ +## Fields + + + + + +
NameDatatypeDescription
connector_labelstring The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +
+appflow:RegisterConnector,
+lambda:InvokeFunction
+ +### List +
+appflow:ListConnectors
+ + +## Example +```sql +SELECT +region, +connector_label +FROM awscc.appflow.connectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appflow/flow/index.md b/docs/awscc-docs/providers/awscc/appflow/flow/index.md new file mode 100644 index 0000000000..a8d5a4b3f7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appflow/flow/index.md @@ -0,0 +1,97 @@ +--- +title: flow +hide_title: false +hide_table_of_contents: false +keywords: + - flow + - 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 +--- +Gets an individual flow resource + +## Overview + + + + + +
Nameflow
TypeResource
Descriptionflow
Idawscc.appflow.flow
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringARN identifier of the flow.
flow_namestringName of the flow.
descriptionstringDescription of the flow.
k_ms_arnstringThe 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.
trigger_configobjectTrigger settings of the flow.
flow_statusstringFlow activation status for Scheduled- and Event-triggered flows
source_flow_configobjectConfigurations of Source connector of the flow.
destination_flow_config_listarrayList of Destination connectors of the flow.
tasksarrayList of tasks for the flow.
tagsarrayList of Tags.
metadata_catalog_configobjectConfigurations of metadata catalog of the flow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow resource, the following permissions are required: + +### Read +
+appflow:DescribeFlow,
+appflow:ListTagsForResource
+ +### Update +
+appflow:UpdateFlow,
+appflow:StartFlow,
+appflow:StopFlow,
+appflow:TagResource,
+appflow:UntagResource,
+appflow:ListTagsForResource,
+appflow:UseConnectorProfile,
+iam:PassRole,
+s3:ListAllMyBuckets,
+s3:GetBucketLocation,
+s3:GetBucketPolicy,
+kms:ListGrants,
+secretsmanager:CreateSecret,
+secretsmanager:PutResourcePolicy
+ +### Delete +
+appflow:DeleteFlow
+ + +## Example +```sql +SELECT +region, +flow_arn, +flow_name, +description, +k_ms_arn, +trigger_config, +flow_status, +source_flow_config, +destination_flow_config_list, +tasks, +tags, +metadata_catalog_config +FROM awscc.appflow.flow +WHERE region = 'us-east-1' +AND data__Identifier = '<FlowName>' +``` diff --git a/docs/awscc-docs/providers/awscc/appflow/flows/index.md b/docs/awscc-docs/providers/awscc/appflow/flows/index.md new file mode 100644 index 0000000000..de47c30bb7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appflow/flows/index.md @@ -0,0 +1,73 @@ +--- +title: flows +hide_title: false +hide_table_of_contents: false +keywords: + - flows + - 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 +--- +Retrieves a list of flows in a region + +## Overview + + + + + +
Nameflows
TypeResource
Descriptionflows
Idawscc.appflow.flows
+ +## Fields + + + + + +
NameDatatypeDescription
flow_namestringName of the flow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flows resource, the following permissions are required: + +### Create +
+appflow:CreateFlow,
+appflow:StartFlow,
+appflow:TagResource,
+appflow:ListTagsForResource,
+appflow:UseConnectorProfile,
+iam:PassRole,
+s3:ListAllMyBuckets,
+s3:GetBucketLocation,
+s3:GetBucketPolicy,
+kms:ListGrants,
+kms:ListKeys,
+kms:DescribeKey,
+kms:ListAliases,
+kms:CreateGrant,
+secretsmanager:CreateSecret,
+secretsmanager:PutResourcePolicy
+ +### List +
+appflow:ListFlows
+ + +## Example +```sql +SELECT +region, +flow_name +FROM awscc.appflow.flows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appflow/index.md b/docs/awscc-docs/providers/awscc/appflow/index.md new file mode 100644 index 0000000000..bc7b9af8be --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appflow/index.md @@ -0,0 +1,43 @@ +--- +title: appflow +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The appflow service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+connector
+connector_profile
+connector_profiles +
+
+connectors
+flow
+flows +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/appintegrations/data_integration/index.md b/docs/awscc-docs/providers/awscc/appintegrations/data_integration/index.md new file mode 100644 index 0000000000..a141a9d212 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appintegrations/data_integration/index.md @@ -0,0 +1,108 @@ +--- +title: data_integration +hide_title: false +hide_table_of_contents: false +keywords: + - data_integration + - 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 +--- +Gets an individual data_integration resource + +## Overview + + + + + +
Namedata_integration
TypeResource
Descriptiondata_integration
Idawscc.appintegrations.data_integration
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe data integration description.
idstringThe unique identifer of the data integration.
data_integration_arnstringThe Amazon Resource Name (ARN) of the data integration.
namestringThe name of the data integration.
kms_keystringThe KMS key of the data integration.
schedule_configobjectThe name of the data and how often it should be pulled from the source.
source_ur_istringThe URI of the data source.
tagsarrayThe tags (keys and values) associated with the data integration.
file_configurationobjectThe configuration for what files should be pulled from the source.
object_configurationobjectThe configuration for what data should be pulled from the source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_integration resource, the following permissions are required: + +### Read +
+app-integrations:GetDataIntegration,
+app-integrations:ListTagsForResource
+ +### Update +
+app-integrations:GetDataIntegration,
+app-integrations:UpdateDataIntegration,
+app-integrations:TagResource,
+app-integrations:UntagResource,
+appflow:DescribeConnectorProfiles,
+appflow:DeleteFlow,
+appflow:DescribeConnectorEntity,
+appflow:UseConnectorProfile,
+appflow:TagResource,
+appflow:UntagResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:ListAliases,
+kms:ListGrants,
+kms:ListKeys
+ +### Delete +
+app-integrations:DeleteDataIntegration,
+app-integrations:UntagResource,
+appflow:CreateFlow,
+appflow:DeleteFlow,
+appflow:DescribeConnectorEntity,
+appflow:UseConnectorProfile,
+appflow:TagResource,
+appflow:UntagResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:ListAliases,
+kms:ListGrants,
+kms:ListKeys
+ + +## Example +```sql +SELECT +region, +description, +id, +data_integration_arn, +name, +kms_key, +schedule_config, +source_ur_i, +tags, +file_configuration, +object_configuration +FROM awscc.appintegrations.data_integration +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md b/docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md new file mode 100644 index 0000000000..b245ec511a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md @@ -0,0 +1,74 @@ +--- +title: data_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - data_integrations + - 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 +--- +Retrieves a list of data_integrations in a region + +## Overview + + + + + +
Namedata_integrations
TypeResource
Descriptiondata_integrations
Idawscc.appintegrations.data_integrations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifer of the data integration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_integrations resource, the following permissions are required: + +### Create +
+app-integrations:CreateDataIntegration,
+app-integrations:TagResource,
+appflow:DescribeConnectorProfiles,
+appflow:CreateFlow,
+appflow:DeleteFlow,
+appflow:DescribeConnectorEntity,
+appflow:UseConnectorProfile,
+appflow:TagResource,
+appflow:UntagResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:ListAliases,
+kms:ListGrants,
+kms:ListKeys,
+s3:GetBucketNotification,
+s3:PutBucketNotification,
+s3:GetEncryptionConfiguration
+ +### List +
+app-integrations:ListDataIntegrations
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.appintegrations.data_integrations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md b/docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md new file mode 100644 index 0000000000..4670e468ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md @@ -0,0 +1,77 @@ +--- +title: event_integration +hide_title: false +hide_table_of_contents: false +keywords: + - event_integration + - 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 +--- +Gets an individual event_integration resource + +## Overview + + + + + +
Nameevent_integration
TypeResource
Descriptionevent_integration
Idawscc.appintegrations.event_integration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe event integration description.
event_integration_arnstringThe Amazon Resource Name (ARN) of the event integration.
namestringThe name of the event integration.
event_bridge_busstringThe Amazon Eventbridge bus for the event integration.
event_filterobjectThe EventFilter (source) associated with the event integration.
tagsarrayThe tags (keys and values) associated with the event integration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_integration resource, the following permissions are required: + +### Read +
+app-integrations:GetEventIntegration,
+app-integrations:ListTagsForResource
+ +### Update +
+app-integrations:GetEventIntegration,
+app-integrations:UpdateEventIntegration,
+app-integrations:TagResource,
+app-integrations:UntagResource
+ +### Delete +
+app-integrations:DeleteEventIntegration
+ + +## Example +```sql +SELECT +region, +description, +event_integration_arn, +name, +event_bridge_bus, +event_filter, +tags +FROM awscc.appintegrations.event_integration +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md b/docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md new file mode 100644 index 0000000000..c1bcfd270c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md @@ -0,0 +1,59 @@ +--- +title: event_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - event_integrations + - 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 +--- +Retrieves a list of event_integrations in a region + +## Overview + + + + + +
Nameevent_integrations
TypeResource
Descriptionevent_integrations
Idawscc.appintegrations.event_integrations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the event integration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_integrations resource, the following permissions are required: + +### Create +
+app-integrations:CreateEventIntegration,
+app-integrations:TagResource
+ +### List +
+app-integrations:ListEventIntegrations
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.appintegrations.event_integrations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appintegrations/index.md b/docs/awscc-docs/providers/awscc/appintegrations/index.md new file mode 100644 index 0000000000..01197d8d5a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appintegrations/index.md @@ -0,0 +1,41 @@ +--- +title: appintegrations +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The appintegrations service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+data_integration
+data_integrations +
+
+event_integration
+event_integrations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/index.md new file mode 100644 index 0000000000..669f6e4837 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationautoscaling/index.md @@ -0,0 +1,41 @@ +--- +title: applicationautoscaling +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The applicationautoscaling service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+scalable_target
+scalable_targets +
+
+scaling_policies
+scaling_policy +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_target/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_target/index.md new file mode 100644 index 0000000000..591c12968c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_target/index.md @@ -0,0 +1,92 @@ +--- +title: scalable_target +hide_title: false +hide_table_of_contents: false +keywords: + - scalable_target + - 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 +--- +Gets an individual scalable_target resource + +## Overview + + + + + +
Namescalable_target
TypeResource
Descriptionscalable_target
Idawscc.applicationautoscaling.scalable_target
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
idstringThis value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
max_capacityintegerThe maximum 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
min_capacityintegerThe 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
resource_idstringThe identifier of the resource associated with the scalable target
role_ar_nstringSpecify 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.
scalable_dimensionstringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
scheduled_actionsarrayThe scheduled actions for the scalable target. Duplicates aren't allowed.
service_namespacestringThe namespace of the AWS service that provides the resource, or a custom-resource
suspended_stateobjectAn 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scalable_target resource, the following permissions are required: + +### Read +
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:DescribeScheduledActions
+ +### Update +
+application-autoscaling:RegisterScalableTarget,
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:DescribeScheduledActions,
+application-autoscaling:DeleteScheduledAction,
+application-autoscaling:PutScheduledAction,
+cloudwatch:PutMetricAlarm,
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms,
+lambda:GetProvisionedConcurrencyConfig,
+lambda:PutProvisionedConcurrencyConfig,
+lambda:DeleteProvisionedConcurrencyConfig
+ +### Delete +
+application-autoscaling:DeregisterScalableTarget
+ + +## Example +```sql +SELECT +region, +id, +max_capacity, +min_capacity, +resource_id, +role_ar_n, +scalable_dimension, +scheduled_actions, +service_namespace, +suspended_state +FROM awscc.applicationautoscaling.scalable_target +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceId>' +AND data__Identifier = '<ScalableDimension>' +AND data__Identifier = '<ServiceNamespace>' +``` diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md new file mode 100644 index 0000000000..6f47b26cfc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md @@ -0,0 +1,73 @@ +--- +title: scalable_targets +hide_title: false +hide_table_of_contents: false +keywords: + - scalable_targets + - 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 +--- +Retrieves a list of scalable_targets in a region + +## Overview + + + + + +
Namescalable_targets
TypeResource
Descriptionscalable_targets
Idawscc.applicationautoscaling.scalable_targets
+ +## Fields + + + + + + + +
NameDatatypeDescription
resource_idstringThe identifier of the resource associated with the scalable target
scalable_dimensionstringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
service_namespacestringThe namespace of the AWS service that provides the resource, or a custom-resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scalable_targets resource, the following permissions are required: + +### Create +
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:RegisterScalableTarget,
+application-autoscaling:DescribeScheduledActions,
+application-autoscaling:PutScheduledAction,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+cloudwatch:PutMetricAlarm,
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms,
+lambda:GetProvisionedConcurrencyConfig,
+lambda:PutProvisionedConcurrencyConfig,
+lambda:DeleteProvisionedConcurrencyConfig
+ +### List +
+application-autoscaling:DescribeScalableTargets
+ + +## Example +```sql +SELECT +region, +resource_id, +scalable_dimension, +service_namespace +FROM awscc.applicationautoscaling.scalable_targets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md new file mode 100644 index 0000000000..75bf6bd0ad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md @@ -0,0 +1,61 @@ +--- +title: scaling_policies +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policies + - 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 +--- +Retrieves a list of scaling_policies in a region + +## Overview + + + + + +
Namescaling_policies
TypeResource
Descriptionscaling_policies
Idawscc.applicationautoscaling.scaling_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
arnstringARN is a read only property for the resource.
scalable_dimensionstringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scaling_policies resource, the following permissions are required: + +### Create +
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:PutScalingPolicy
+ +### List +
+application-autoscaling:DescribeScalingPolicies
+ + +## Example +```sql +SELECT +region, +arn, +scalable_dimension +FROM awscc.applicationautoscaling.scaling_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md new file mode 100644 index 0000000000..7b8cad947a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md @@ -0,0 +1,82 @@ +--- +title: scaling_policy +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policy + - 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 +--- +Gets an individual scaling_policy resource + +## Overview + + + + + +
Namescaling_policy
TypeResource
Descriptionscaling_policy
Idawscc.applicationautoscaling.scaling_policy
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
policy_namestringThe name of the scaling policy.<br/><br/>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.
policy_typestringThe scaling policy type.<br/><br/>The following policy types are supported:<br/><br/>TargetTrackingScaling Not supported for Amazon EMR<br/><br/>StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
resource_idstringThe identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
scalable_dimensionstringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
scaling_target_idstringThe 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.
service_namespacestringThe namespace of the AWS service that provides the resource, or a custom-resource.
step_scaling_policy_configurationobjectA step scaling policy.
target_tracking_scaling_policy_configurationobjectA target tracking scaling policy.
arnstringARN is a read only property for the resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scaling_policy resource, the following permissions are required: + +### Read +
+application-autoscaling:DescribeScalingPolicies
+ +### Update +
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:PutScalingPolicy
+ +### Delete +
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:DeleteScalingPolicy
+ + +## Example +```sql +SELECT +region, +policy_name, +policy_type, +resource_id, +scalable_dimension, +scaling_target_id, +service_namespace, +step_scaling_policy_configuration, +target_tracking_scaling_policy_configuration, +arn +FROM awscc.applicationautoscaling.scaling_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +AND data__Identifier = '<ScalableDimension>' +``` diff --git a/docs/awscc-docs/providers/awscc/applicationinsights/application/index.md b/docs/awscc-docs/providers/awscc/applicationinsights/application/index.md new file mode 100644 index 0000000000..6cc8db5ff1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationinsights/application/index.md @@ -0,0 +1,83 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.applicationinsights.application
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
resource_group_namestringThe name of the resource group.
application_ar_nstringThe ARN of the ApplicationInsights application.
c_we_monitor_enabledbooleanIndicates whether Application Insights can listen to CloudWatch events for the application resources.
ops_center_enabledbooleanWhen set to true, creates opsItems for any problems detected on an application.
ops_item_sn_stopic_arnstringThe SNS topic provided to Application Insights that is associated to the created opsItem.
tagsarrayThe tags of Application Insights application.
custom_componentsarrayThe custom grouped components.
log_pattern_setsarrayThe log pattern sets.
auto_configuration_enabledbooleanIf set to true, application will be configured with recommended monitoring configuration.
component_monitoring_settingsarrayThe monitoring settings of the components.
grouping_typestringThe grouping type of the application
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+*
+ +### Update +
+*
+ +### Delete +
+*
+ + +## Example +```sql +SELECT +region, +resource_group_name, +application_ar_n, +c_we_monitor_enabled, +ops_center_enabled, +ops_item_sn_stopic_arn, +tags, +custom_components, +log_pattern_sets, +auto_configuration_enabled, +component_monitoring_settings, +grouping_type +FROM awscc.applicationinsights.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationARN>' +``` diff --git a/docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md b/docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md new file mode 100644 index 0000000000..28071fc089 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md @@ -0,0 +1,58 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.applicationinsights.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_ar_nstringThe ARN of the ApplicationInsights application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+*
+ +### List +
+*
+ + +## Example +```sql +SELECT +region, +application_ar_n +FROM awscc.applicationinsights.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/applicationinsights/index.md b/docs/awscc-docs/providers/awscc/applicationinsights/index.md new file mode 100644 index 0000000000..e9ec883106 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/applicationinsights/index.md @@ -0,0 +1,39 @@ +--- +title: applicationinsights +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The applicationinsights service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+application +
+
+applications +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configuration/index.md b/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configuration/index.md new file mode 100644 index 0000000000..31a978858c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configuration/index.md @@ -0,0 +1,73 @@ +--- +title: auto_scaling_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_configuration + - 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 +--- +Gets an individual auto_scaling_configuration resource + +## Overview + + + + + +
Nameauto_scaling_configuration
TypeResource
Descriptionauto_scaling_configuration
Idawscc.apprunner.auto_scaling_configuration
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
auto_scaling_configuration_arnstringThe Amazon Resource Name (ARN) of this auto scaling configuration.
auto_scaling_configuration_namestringThe 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.
auto_scaling_configuration_revisionintegerThe revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.
max_concurrencyintegerThe 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.
max_sizeintegerThe maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.
min_sizeintegerThe 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.
latestbooleanIt'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.
tagsarrayA list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the auto_scaling_configuration resource, the following permissions are required: + +### Read +
+apprunner:DescribeAutoScalingConfiguration
+ +### Delete +
+apprunner:DeleteAutoScalingConfiguration
+ + +## Example +```sql +SELECT +region, +auto_scaling_configuration_arn, +auto_scaling_configuration_name, +auto_scaling_configuration_revision, +max_concurrency, +max_size, +min_size, +latest, +tags +FROM awscc.apprunner.auto_scaling_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<AutoScalingConfigurationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configurations/index.md b/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configurations/index.md new file mode 100644 index 0000000000..cc398f5a8e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: auto_scaling_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_configurations + - 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 +--- +Retrieves a list of auto_scaling_configurations in a region + +## Overview + + + + + +
Nameauto_scaling_configurations
TypeResource
Descriptionauto_scaling_configurations
Idawscc.apprunner.auto_scaling_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
auto_scaling_configuration_arnstringThe Amazon Resource Name (ARN) of this auto scaling configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the auto_scaling_configurations resource, the following permissions are required: + +### Create +
+apprunner:CreateAutoScalingConfiguration,
+apprunner:DescribeAutoScalingConfiguration,
+apprunner:TagResource
+ +### List +
+apprunner:ListAutoScalingConfiguration
+ + +## Example +```sql +SELECT +region, +auto_scaling_configuration_arn +FROM awscc.apprunner.auto_scaling_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/index.md b/docs/awscc-docs/providers/awscc/apprunner/index.md new file mode 100644 index 0000000000..852d158ac2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/index.md @@ -0,0 +1,47 @@ +--- +title: apprunner +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The apprunner service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+auto_scaling_configuration
+auto_scaling_configurations
+observability_configuration
+observability_configurations
+service +
+
+services
+vpc_connector
+vpc_connectors
+vpc_ingress_connection
+vpc_ingress_connections +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/apprunner/observability_configuration/index.md b/docs/awscc-docs/providers/awscc/apprunner/observability_configuration/index.md new file mode 100644 index 0000000000..3a9cd1ad6e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/observability_configuration/index.md @@ -0,0 +1,69 @@ +--- +title: observability_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - observability_configuration + - 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 +--- +Gets an individual observability_configuration resource + +## Overview + + + + + +
Nameobservability_configuration
TypeResource
Descriptionobservability_configuration
Idawscc.apprunner.observability_configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
observability_configuration_arnstringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
observability_configuration_namestringA 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.
observability_configuration_revisionintegerThe revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.
latestbooleanIt'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.
trace_configurationobjectThe configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
tagsarrayA list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the observability_configuration resource, the following permissions are required: + +### Read +
+apprunner:DescribeObservabilityConfiguration
+ +### Delete +
+apprunner:DeleteObservabilityConfiguration
+ + +## Example +```sql +SELECT +region, +observability_configuration_arn, +observability_configuration_name, +observability_configuration_revision, +latest, +trace_configuration, +tags +FROM awscc.apprunner.observability_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<ObservabilityConfigurationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md b/docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md new file mode 100644 index 0000000000..9b7109615d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: observability_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - observability_configurations + - 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 +--- +Retrieves a list of observability_configurations in a region + +## Overview + + + + + +
Nameobservability_configurations
TypeResource
Descriptionobservability_configurations
Idawscc.apprunner.observability_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
observability_configuration_arnstringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the observability_configurations resource, the following permissions are required: + +### Create +
+apprunner:CreateObservabilityConfiguration,
+apprunner:DescribeObservabilityConfiguration,
+apprunner:TagResource
+ +### List +
+apprunner:ListObservabilityConfigurations
+ + +## Example +```sql +SELECT +region, +observability_configuration_arn +FROM awscc.apprunner.observability_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/service/index.md b/docs/awscc-docs/providers/awscc/apprunner/service/index.md new file mode 100644 index 0000000000..abfa197754 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/service/index.md @@ -0,0 +1,88 @@ +--- +title: service +hide_title: false +hide_table_of_contents: false +keywords: + - service + - 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 +--- +Gets an individual service resource + +## Overview + + + + + +
Nameservice
TypeResource
Descriptionservice
Idawscc.apprunner.service
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
service_namestringThe AppRunner Service Name.
service_idstringThe AppRunner Service Id
service_arnstringThe Amazon Resource Name (ARN) of the AppRunner Service.
service_urlstringThe Service Url of the AppRunner Service.
statusstringAppRunner Service status.
source_configurationobject
instance_configurationobject
tagsarray
encryption_configurationobject
health_check_configurationobject
observability_configurationobject
auto_scaling_configuration_arnstringAutoscaling configuration ARN
network_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +
+apprunner:DescribeService
+ +### Update +
+apprunner:UpdateService,
+iam:PassRole
+ +### Delete +
+apprunner:DeleteService
+ + +## Example +```sql +SELECT +region, +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 awscc.apprunner.service +WHERE region = 'us-east-1' +AND data__Identifier = '<ServiceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/services/index.md b/docs/awscc-docs/providers/awscc/apprunner/services/index.md new file mode 100644 index 0000000000..273e68906d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/services/index.md @@ -0,0 +1,69 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - 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 +--- +Retrieves a list of services in a region + +## Overview + + + + + +
Nameservices
TypeResource
Descriptionservices
Idawscc.apprunner.services
+ +## Fields + + + + + +
NameDatatypeDescription
service_arnstringThe Amazon Resource Name (ARN) of the AppRunner Service.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +
+apprunner:CreateService,
+apprunner:TagResource,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+logs:CreateLogGroup,
+logs:PutRetentionPolicy,
+logs:CreateLogStream,
+logs:PutLogEvents,
+logs:DescribeLogStreams,
+events:PutRule,
+events:PutTargets
+ +### List +
+apprunner:ListServices,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +service_arn +FROM awscc.apprunner.services +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md b/docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md new file mode 100644 index 0000000000..549cd63ba5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md @@ -0,0 +1,69 @@ +--- +title: vpc_connector +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connector + - 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 +--- +Gets an individual vpc_connector resource + +## Overview + + + + + +
Namevpc_connector
TypeResource
Descriptionvpc_connector
Idawscc.apprunner.vpc_connector
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
vpc_connector_namestringA name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
vpc_connector_arnstringThe Amazon Resource Name (ARN) of this VPC connector.
vpc_connector_revisionintegerThe revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
subnetsarrayA 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.
security_groupsarrayA 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.
tagsarrayA list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_connector resource, the following permissions are required: + +### Read +
+apprunner:DescribeVpcConnector
+ +### Delete +
+apprunner:DeleteVpcConnector
+ + +## Example +```sql +SELECT +region, +vpc_connector_name, +vpc_connector_arn, +vpc_connector_revision, +subnets, +security_groups, +tags +FROM awscc.apprunner.vpc_connector +WHERE region = 'us-east-1' +AND data__Identifier = '<VpcConnectorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md b/docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md new file mode 100644 index 0000000000..74fbdca3d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md @@ -0,0 +1,63 @@ +--- +title: vpc_connectors +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connectors + - 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 +--- +Retrieves a list of vpc_connectors in a region + +## Overview + + + + + +
Namevpc_connectors
TypeResource
Descriptionvpc_connectors
Idawscc.apprunner.vpc_connectors
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_connector_arnstringThe Amazon Resource Name (ARN) of this VPC connector.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_connectors resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+apprunner:CreateVpcConnector,
+apprunner:DescribeVpcConnector,
+apprunner:TagResource,
+ec2:DescribeSubnets,
+ec2:DescribeSecurityGroups
+ +### List +
+apprunner:ListVpcConnectors
+ + +## Example +```sql +SELECT +region, +vpc_connector_arn +FROM awscc.apprunner.vpc_connectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connection/index.md b/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connection/index.md new file mode 100644 index 0000000000..a1460636ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connection/index.md @@ -0,0 +1,75 @@ +--- +title: vpc_ingress_connection +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_ingress_connection + - 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 +--- +Gets an individual vpc_ingress_connection resource + +## Overview + + + + + +
Namevpc_ingress_connection
TypeResource
Descriptionvpc_ingress_connection
Idawscc.apprunner.vpc_ingress_connection
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
vpc_ingress_connection_arnstringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
vpc_ingress_connection_namestringThe customer-provided Vpc Ingress Connection name.
service_arnstringThe Amazon Resource Name (ARN) of the service.
statusstringThe current status of the VpcIngressConnection.
domain_namestringThe Domain name associated with the VPC Ingress Connection.
ingress_vpc_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_ingress_connection resource, the following permissions are required: + +### Read +
+apprunner:DescribeVpcIngressConnection
+ +### Update +
+apprunner:UpdateVpcIngressConnection
+ +### Delete +
+apprunner:DeleteVpcIngressConnection
+ + +## Example +```sql +SELECT +region, +vpc_ingress_connection_arn, +vpc_ingress_connection_name, +service_arn, +status, +domain_name, +ingress_vpc_configuration, +tags +FROM awscc.apprunner.vpc_ingress_connection +WHERE region = 'us-east-1' +AND data__Identifier = '<VpcIngressConnectionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connections/index.md b/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connections/index.md new file mode 100644 index 0000000000..33aa7e9566 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connections/index.md @@ -0,0 +1,63 @@ +--- +title: vpc_ingress_connections +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_ingress_connections + - 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 +--- +Retrieves a list of vpc_ingress_connections in a region + +## Overview + + + + + +
Namevpc_ingress_connections
TypeResource
Descriptionvpc_ingress_connections
Idawscc.apprunner.vpc_ingress_connections
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_ingress_connection_arnstringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_ingress_connections resource, the following permissions are required: + +### Create +
+apprunner:CreateVpcIngressConnection,
+apprunner:DescribeVpcIngressConnection,
+ec2:DescribeVpcs,
+ec2:DescribeVpcEndpoints,
+ec2:DescribeSubnets,
+apprunner:TagResource
+ +### List +
+apprunner:ListVpcIngressConnections
+ + +## Example +```sql +SELECT +region, +vpc_ingress_connection_arn +FROM awscc.apprunner.vpc_ingress_connections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/app_block/index.md b/docs/awscc-docs/providers/awscc/appstream/app_block/index.md new file mode 100644 index 0000000000..128179fb29 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/app_block/index.md @@ -0,0 +1,77 @@ +--- +title: app_block +hide_title: false +hide_table_of_contents: false +keywords: + - app_block + - 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 +--- +Gets an individual app_block resource + +## Overview + + + + + +
Nameapp_block
TypeResource
Descriptionapp_block
Idawscc.appstream.app_block
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
descriptionstring
display_namestring
source_s3_locationobject
setup_script_detailsobject
tagsarray
created_timestring
packaging_typestring
post_setup_script_detailsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_block resource, the following permissions are required: + +### Read +
+appstream:DescribeAppBlocks
+ +### Delete +
+appstream:DeleteAppBlock
+ + +## Example +```sql +SELECT +region, +name, +arn, +description, +display_name, +source_s3_location, +setup_script_details, +tags, +created_time, +packaging_type, +post_setup_script_details +FROM awscc.appstream.app_block +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/app_block_builder/index.md b/docs/awscc-docs/providers/awscc/appstream/app_block_builder/index.md new file mode 100644 index 0000000000..6c65cea9f9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/app_block_builder/index.md @@ -0,0 +1,100 @@ +--- +title: app_block_builder +hide_title: false +hide_table_of_contents: false +keywords: + - app_block_builder + - 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 +--- +Gets an individual app_block_builder resource + +## Overview + + + + + +
Nameapp_block_builder
TypeResource
Descriptionapp_block_builder
Idawscc.appstream.app_block_builder
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
descriptionstring
display_namestring
platformstring
access_endpointsarray
tagsarray
vpc_configobject
enable_default_internet_accessboolean
iam_role_arnstring
created_timestring
instance_typestring
app_block_arnsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_block_builder resource, the following permissions are required: + +### Read +
+appstream:DescribeAppBlockBuilders
+ +### Update +
+appstream:UpdateAppBlockBuilder,
+appstream:DescribeAppBlockBuilders,
+appstream:StartAppBlockBuilder,
+appstream:StopAppBlockBuilder,
+appstream:AssociateAppBlockBuilderAppBlock,
+appstream:DisassociateAppBlockBuilderAppBlock,
+appstream:DescribeAppBlockBuilderAppBlockAssociations,
+appstream:ListTagsForResource,
+appstream:TagResource,
+appstream:UntagResource,
+iam:PassRole
+ +### Delete +
+appstream:DescribeAppBlockBuilders,
+appstream:DeleteAppBlockBuilder,
+appstream:DisassociateAppBlockBuilderAppBlock,
+appstream:DescribeAppBlockBuilderAppBlockAssociations
+ + +## Example +```sql +SELECT +region, +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 awscc.appstream.app_block_builder +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/app_block_builders/index.md b/docs/awscc-docs/providers/awscc/appstream/app_block_builders/index.md new file mode 100644 index 0000000000..c1fbe83e94 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/app_block_builders/index.md @@ -0,0 +1,64 @@ +--- +title: app_block_builders +hide_title: false +hide_table_of_contents: false +keywords: + - app_block_builders + - 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 +--- +Retrieves a list of app_block_builders in a region + +## Overview + + + + + +
Nameapp_block_builders
TypeResource
Descriptionapp_block_builders
Idawscc.appstream.app_block_builders
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_block_builders resource, the following permissions are required: + +### Create +
+appstream:CreateAppBlockBuilder,
+appstream:DescribeAppBlockBuilders,
+appstream:StartAppBlockBuilder,
+appstream:AssociateAppBlockBuilderAppBlock,
+appstream:DescribeAppBlockBuilderAppBlockAssociations,
+appstream:TagResource,
+iam:PassRole
+ +### List +
+appstream:DescribeAppBlockBuilders
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.appstream.app_block_builders +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/app_blocks/index.md b/docs/awscc-docs/providers/awscc/appstream/app_blocks/index.md new file mode 100644 index 0000000000..6db44c9014 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/app_blocks/index.md @@ -0,0 +1,58 @@ +--- +title: app_blocks +hide_title: false +hide_table_of_contents: false +keywords: + - app_blocks + - 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 +--- +Retrieves a list of app_blocks in a region + +## Overview + + + + + +
Nameapp_blocks
TypeResource
Descriptionapp_blocks
Idawscc.appstream.app_blocks
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_blocks resource, the following permissions are required: + +### Create +
+appstream:CreateAppBlock,
+appstream:TagResource,
+s3:GetObject,
+s3:ListBucket,
+s3:GetBucketOwnershipControls
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.appstream.app_blocks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/application/index.md b/docs/awscc-docs/providers/awscc/appstream/application/index.md new file mode 100644 index 0000000000..5f64609235 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/application/index.md @@ -0,0 +1,90 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.appstream.application
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
display_namestring
descriptionstring
launch_pathstring
launch_parametersstring
working_directorystring
instance_familiesarray
icon_s3_locationobject
arnstring
app_block_arnstring
platformsarray
tagsarray
attributes_to_deletearray
created_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+appstream:DescribeApplications
+ +### Update +
+appstream:UpdateApplication,
+s3:GetObject
+ +### Delete +
+appstream:DeleteApplication
+ + +## Example +```sql +SELECT +region, +name, +display_name, +description, +launch_path, +launch_parameters, +working_directory, +instance_families, +icon_s3_location, +arn, +app_block_arn, +platforms, +tags, +attributes_to_delete, +created_time +FROM awscc.appstream.application +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/application_entitlement_association/index.md b/docs/awscc-docs/providers/awscc/appstream/application_entitlement_association/index.md new file mode 100644 index 0000000000..f75c7b7775 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/application_entitlement_association/index.md @@ -0,0 +1,66 @@ +--- +title: application_entitlement_association +hide_title: false +hide_table_of_contents: false +keywords: + - application_entitlement_association + - 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 +--- +Gets an individual application_entitlement_association resource + +## Overview + + + + + +
Nameapplication_entitlement_association
TypeResource
Descriptionapplication_entitlement_association
Idawscc.appstream.application_entitlement_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
stack_namestring
entitlement_namestring
application_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_entitlement_association resource, the following permissions are required: + +### Read +
+appstream:ListEntitledApplications
+ +### Delete +
+appstream:DisassociateApplicationFromEntitlement,
+appstream:ListEntitledApplications
+ + +## Example +```sql +SELECT +region, +stack_name, +entitlement_name, +application_identifier +FROM awscc.appstream.application_entitlement_association +WHERE region = 'us-east-1' +AND data__Identifier = '<StackName>' +AND data__Identifier = '<EntitlementName>' +AND data__Identifier = '<ApplicationIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/application_entitlement_associations/index.md b/docs/awscc-docs/providers/awscc/appstream/application_entitlement_associations/index.md new file mode 100644 index 0000000000..fa62cdfe81 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/application_entitlement_associations/index.md @@ -0,0 +1,59 @@ +--- +title: application_entitlement_associations +hide_title: false +hide_table_of_contents: false +keywords: + - application_entitlement_associations + - 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 +--- +Retrieves a list of application_entitlement_associations in a region + +## Overview + + + + + +
Nameapplication_entitlement_associations
TypeResource
Descriptionapplication_entitlement_associations
Idawscc.appstream.application_entitlement_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
stack_namestring
entitlement_namestring
application_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_entitlement_associations resource, the following permissions are required: + +### Create +
+appstream:AssociateApplicationToEntitlement,
+appstream:ListEntitledApplications
+ + +## Example +```sql +SELECT +region, +stack_name, +entitlement_name, +application_identifier +FROM awscc.appstream.application_entitlement_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/application_fleet_association/index.md b/docs/awscc-docs/providers/awscc/appstream/application_fleet_association/index.md new file mode 100644 index 0000000000..6e027b333e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/application_fleet_association/index.md @@ -0,0 +1,63 @@ +--- +title: application_fleet_association +hide_title: false +hide_table_of_contents: false +keywords: + - application_fleet_association + - 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 +--- +Gets an individual application_fleet_association resource + +## Overview + + + + + +
Nameapplication_fleet_association
TypeResource
Descriptionapplication_fleet_association
Idawscc.appstream.application_fleet_association
+ +## Fields + + + + + + +
NameDatatypeDescription
fleet_namestring
application_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_fleet_association resource, the following permissions are required: + +### Read +
+appstream:DescribeApplicationFleetAssociations
+ +### Delete +
+appstream:DisassociateApplicationFleet,
+appstream:DescribeApplicationFleetAssociations
+ + +## Example +```sql +SELECT +region, +fleet_name, +application_arn +FROM awscc.appstream.application_fleet_association +WHERE region = 'us-east-1' +AND data__Identifier = '<FleetName>' +AND data__Identifier = '<ApplicationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/application_fleet_associations/index.md b/docs/awscc-docs/providers/awscc/appstream/application_fleet_associations/index.md new file mode 100644 index 0000000000..2a435ec209 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/application_fleet_associations/index.md @@ -0,0 +1,57 @@ +--- +title: application_fleet_associations +hide_title: false +hide_table_of_contents: false +keywords: + - application_fleet_associations + - 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 +--- +Retrieves a list of application_fleet_associations in a region + +## Overview + + + + + +
Nameapplication_fleet_associations
TypeResource
Descriptionapplication_fleet_associations
Idawscc.appstream.application_fleet_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
fleet_namestring
application_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_fleet_associations resource, the following permissions are required: + +### Create +
+appstream:AssociateApplicationFleet,
+appstream:DescribeApplicationFleetAssociations
+ + +## Example +```sql +SELECT +region, +fleet_name, +application_arn +FROM awscc.appstream.application_fleet_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/applications/index.md b/docs/awscc-docs/providers/awscc/appstream/applications/index.md new file mode 100644 index 0000000000..0a9e4f374d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/applications/index.md @@ -0,0 +1,56 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.appstream.applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+s3:GetObject,
+appstream:CreateApplication,
+appstream:TagResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.appstream.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/directory_config/index.md b/docs/awscc-docs/providers/awscc/appstream/directory_config/index.md new file mode 100644 index 0000000000..9419d3326e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/directory_config/index.md @@ -0,0 +1,87 @@ +--- +title: directory_config +hide_title: false +hide_table_of_contents: false +keywords: + - directory_config + - 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 +--- +Gets an individual directory_config resource + +## Overview + + + + + +
Namedirectory_config
TypeResource
Descriptiondirectory_config
Idawscc.appstream.directory_config
+ +## Fields + + + + + + + + +
NameDatatypeDescription
organizational_unit_distinguished_namesarray
service_account_credentialsobject
directory_namestring
certificate_based_auth_propertiesobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the directory_config resource, the following permissions are required: + +### Update +
+appstream:CreateDirectoryConfig,
+appstream:DeleteDirectoryConfig,
+appstream:DescribeDirectoryConfig,
+appstream:UpdateDirectoryConfig,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### Read +
+appstream:CreateDirectoryConfig,
+appstream:DeleteDirectoryConfig,
+appstream:DescribeDirectoryConfig,
+appstream:UpdateDirectoryConfig,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### Delete +
+appstream:CreateDirectoryConfig,
+appstream:DeleteDirectoryConfig,
+appstream:DescribeDirectoryConfig,
+appstream:UpdateDirectoryConfig,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ + +## Example +```sql +SELECT +region, +organizational_unit_distinguished_names, +service_account_credentials, +directory_name, +certificate_based_auth_properties +FROM awscc.appstream.directory_config +WHERE region = 'us-east-1' +AND data__Identifier = '<DirectoryName>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md b/docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md new file mode 100644 index 0000000000..d3a36cc420 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md @@ -0,0 +1,70 @@ +--- +title: directory_configs +hide_title: false +hide_table_of_contents: false +keywords: + - directory_configs + - 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 +--- +Retrieves a list of directory_configs in a region + +## Overview + + + + + +
Namedirectory_configs
TypeResource
Descriptiondirectory_configs
Idawscc.appstream.directory_configs
+ +## Fields + + + + + +
NameDatatypeDescription
directory_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the directory_configs resource, the following permissions are required: + +### Create +
+appstream:CreateDirectoryConfig,
+appstream:DeleteDirectoryConfig,
+appstream:DescribeDirectoryConfig,
+appstream:UpdateDirectoryConfig,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### List +
+appstream:CreateDirectoryConfig,
+appstream:DeleteDirectoryConfig,
+appstream:DescribeDirectoryConfig,
+appstream:UpdateDirectoryConfig,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ + +## Example +```sql +SELECT +region, +directory_name +FROM awscc.appstream.directory_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/entitlement/index.md b/docs/awscc-docs/providers/awscc/appstream/entitlement/index.md new file mode 100644 index 0000000000..860c5e2d07 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/entitlement/index.md @@ -0,0 +1,76 @@ +--- +title: entitlement +hide_title: false +hide_table_of_contents: false +keywords: + - entitlement + - 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 +--- +Gets an individual entitlement resource + +## Overview + + + + + +
Nameentitlement
TypeResource
Descriptionentitlement
Idawscc.appstream.entitlement
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestring
stack_namestring
descriptionstring
app_visibilitystring
attributesarray
created_timestring
last_modified_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the entitlement resource, the following permissions are required: + +### Read +
+appstream:DescribeEntitlements
+ +### Update +
+appstream:UpdateEntitlement
+ +### Delete +
+appstream:DeleteEntitlement
+ + +## Example +```sql +SELECT +region, +name, +stack_name, +description, +app_visibility, +attributes, +created_time, +last_modified_time +FROM awscc.appstream.entitlement +WHERE region = 'us-east-1' +AND data__Identifier = '<StackName>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/entitlements/index.md b/docs/awscc-docs/providers/awscc/appstream/entitlements/index.md new file mode 100644 index 0000000000..9d2f29a800 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/entitlements/index.md @@ -0,0 +1,56 @@ +--- +title: entitlements +hide_title: false +hide_table_of_contents: false +keywords: + - entitlements + - 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 +--- +Retrieves a list of entitlements in a region + +## Overview + + + + + +
Nameentitlements
TypeResource
Descriptionentitlements
Idawscc.appstream.entitlements
+ +## Fields + + + + + + +
NameDatatypeDescription
stack_namestring
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the entitlements resource, the following permissions are required: + +### Create +
+appstream:CreateEntitlement
+ + +## Example +```sql +SELECT +region, +stack_name, +name +FROM awscc.appstream.entitlements +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/image_builder/index.md b/docs/awscc-docs/providers/awscc/appstream/image_builder/index.md new file mode 100644 index 0000000000..64c3dbbf21 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/image_builder/index.md @@ -0,0 +1,103 @@ +--- +title: image_builder +hide_title: false +hide_table_of_contents: false +keywords: + - image_builder + - 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 +--- +Gets an individual image_builder resource + +## Overview + + + + + +
Nameimage_builder
TypeResource
Descriptionimage_builder
Idawscc.appstream.image_builder
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring
vpc_configobject
enable_default_internet_accessboolean
domain_join_infoobject
appstream_agent_versionstring
namestring
image_namestring
display_namestring
iam_role_arnstring
instance_typestring
tagsarray
streaming_urlstring
image_arnstring
access_endpointsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_builder resource, the following permissions are required: + +### Read +
+appstream:CreateImageBuilder,
+appstream:CreateImageBuilderStreamingURL,
+appstream:CreateStreamingURL,
+appstream:DeleteImageBuilder,
+appstream:DescribeImageBuilders,
+appstream:StartImageBuilder,
+appstream:StopImageBuilder,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### Delete +
+appstream:CreateImageBuilder,
+appstream:CreateImageBuilderStreamingURL,
+appstream:CreateStreamingURL,
+appstream:DeleteImageBuilder,
+appstream:DescribeImageBuilders,
+appstream:StartImageBuilder,
+appstream:StopImageBuilder,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ + +## Example +```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, +tags, +streaming_url, +image_arn, +access_endpoints +FROM awscc.appstream.image_builder +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/image_builders/index.md b/docs/awscc-docs/providers/awscc/appstream/image_builders/index.md new file mode 100644 index 0000000000..3cfa347763 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/image_builders/index.md @@ -0,0 +1,76 @@ +--- +title: image_builders +hide_title: false +hide_table_of_contents: false +keywords: + - image_builders + - 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 +--- +Retrieves a list of image_builders in a region + +## Overview + + + + + +
Nameimage_builders
TypeResource
Descriptionimage_builders
Idawscc.appstream.image_builders
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_builders resource, the following permissions are required: + +### Create +
+appstream:CreateImageBuilder,
+appstream:CreateImageBuilderStreamingURL,
+appstream:CreateStreamingURL,
+appstream:DeleteImageBuilder,
+appstream:DescribeImageBuilders,
+appstream:StartImageBuilder,
+appstream:StopImageBuilder,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ +### List +
+appstream:CreateImageBuilder,
+appstream:CreateImageBuilderStreamingURL,
+appstream:CreateStreamingURL,
+appstream:DeleteImageBuilder,
+appstream:DescribeImageBuilders,
+appstream:StartImageBuilder,
+appstream:StopImageBuilder,
+iam:CreateServiceLinkedRole,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.appstream.image_builders +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appstream/index.md b/docs/awscc-docs/providers/awscc/appstream/index.md new file mode 100644 index 0000000000..e02cf224f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appstream/index.md @@ -0,0 +1,53 @@ +--- +title: appstream +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The appstream service documentation. + +:::info Service Summary + +
+
+total resources: 16
+total selectable resources: 16
+total methods: 16
+
+
+ +::: + +## Resources +
+
+app_block
+app_block_builder
+app_block_builders
+app_blocks
+application
+application_entitlement_association
+application_entitlement_associations
+application_fleet_association +
+
+application_fleet_associations
+applications
+directory_config
+directory_configs
+entitlement
+entitlements
+image_builder
+image_builders +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/appsync/domain_name/index.md b/docs/awscc-docs/providers/awscc/appsync/domain_name/index.md new file mode 100644 index 0000000000..f9ca4cb952 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/domain_name/index.md @@ -0,0 +1,72 @@ +--- +title: domain_name +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name + - 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 +--- +Gets an individual domain_name resource + +## Overview + + + + + +
Namedomain_name
TypeResource
Descriptiondomain_name
Idawscc.appsync.domain_name
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
domain_namestring
descriptionstring
certificate_arnstring
app_sync_domain_namestring
hosted_zone_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_name resource, the following permissions are required: + +### Delete +
+appsync:GetDomainName,
+appsync:DeleteDomainName
+ +### Update +
+appsync:UpdateDomainName
+ +### Read +
+appsync:GetDomainName
+ + +## Example +```sql +SELECT +region, +domain_name, +description, +certificate_arn, +app_sync_domain_name, +hosted_zone_id +FROM awscc.appsync.domain_name +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/domain_name_api_association/index.md b/docs/awscc-docs/providers/awscc/appsync/domain_name_api_association/index.md new file mode 100644 index 0000000000..64641b8c9b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/domain_name_api_association/index.md @@ -0,0 +1,69 @@ +--- +title: domain_name_api_association +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_api_association + - 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 +--- +Gets an individual domain_name_api_association resource + +## Overview + + + + + +
Namedomain_name_api_association
TypeResource
Descriptiondomain_name_api_association
Idawscc.appsync.domain_name_api_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
domain_namestring
api_idstring
api_association_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_name_api_association resource, the following permissions are required: + +### Delete +
+appsync:DisassociateApi,
+appsync:GetApiAssociation
+ +### Update +
+appsync:AssociateApi,
+appsync:GetApiAssociation
+ +### Read +
+appsync:GetApiAssociation
+ + +## Example +```sql +SELECT +region, +domain_name, +api_id, +api_association_identifier +FROM awscc.appsync.domain_name_api_association +WHERE region = 'us-east-1' +AND data__Identifier = '<ApiAssociationIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/domain_name_api_associations/index.md b/docs/awscc-docs/providers/awscc/appsync/domain_name_api_associations/index.md new file mode 100644 index 0000000000..27844ea553 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/domain_name_api_associations/index.md @@ -0,0 +1,55 @@ +--- +title: domain_name_api_associations +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_api_associations + - 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 +--- +Retrieves a list of domain_name_api_associations in a region + +## Overview + + + + + +
Namedomain_name_api_associations
TypeResource
Descriptiondomain_name_api_associations
Idawscc.appsync.domain_name_api_associations
+ +## Fields + + + + + +
NameDatatypeDescription
api_association_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_name_api_associations resource, the following permissions are required: + +### Create +
+appsync:AssociateApi,
+appsync:GetApiAssociation
+ + +## Example +```sql +SELECT +region, +api_association_identifier +FROM awscc.appsync.domain_name_api_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/domain_names/index.md b/docs/awscc-docs/providers/awscc/appsync/domain_names/index.md new file mode 100644 index 0000000000..2560f76a6c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/domain_names/index.md @@ -0,0 +1,61 @@ +--- +title: domain_names +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names + - 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 +--- +Retrieves a list of domain_names in a region + +## Overview + + + + + +
Namedomain_names
TypeResource
Descriptiondomain_names
Idawscc.appsync.domain_names
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_names resource, the following permissions are required: + +### Create +
+appsync:CreateDomainName,
+appsync:GetDomainName,
+acm:DescribeCertificate,
+cloudfront:UpdateDistribution
+ +### List +
+appsync:ListDomainNames
+ + +## Example +```sql +SELECT +region, +domain_name +FROM awscc.appsync.domain_names +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md b/docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md new file mode 100644 index 0000000000..936d08f77a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md @@ -0,0 +1,94 @@ +--- +title: function_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - function_configuration + - 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 +--- +Gets an individual function_configuration resource + +## Overview + + + + + +
Namefunction_configuration
TypeResource
Descriptionfunction_configuration
Idawscc.appsync.function_configuration
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
function_idstringThe unique identifier for the function generated by the service
function_arnstringThe ARN for the function generated by the service
api_idstringThe AWS AppSync GraphQL API that you want to attach using this function.
codestringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
code_s3_locationstringThe Amazon S3 endpoint (where the code is located??).
data_source_namestringThe name of data source this function will attach.
descriptionstringThe function description.
function_versionstringThe version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
max_batch_sizeintegerThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
namestringThe name of the function.
request_mapping_templatestringThe Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
request_mapping_template_s3_locationstringDescribes 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.
response_mapping_templatestringThe Function response mapping template.
response_mapping_template_s3_locationstringThe 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.
runtimeobjectDescribes 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.
sync_configobjectDescribes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the function_configuration resource, the following permissions are required: + +### Read +
+appsync:GetFunction
+ +### Update +
+s3:GetObject,
+appsync:UpdateFunction
+ +### Delete +
+appsync:DeleteFunction
+ + +## Example +```sql +SELECT +region, +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 awscc.appsync.function_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<FunctionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md b/docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md new file mode 100644 index 0000000000..49ad8a77b0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md @@ -0,0 +1,59 @@ +--- +title: function_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - function_configurations + - 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 +--- +Retrieves a list of function_configurations in a region + +## Overview + + + + + +
Namefunction_configurations
TypeResource
Descriptionfunction_configurations
Idawscc.appsync.function_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
function_arnstringThe ARN for the function generated by the service
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the function_configurations resource, the following permissions are required: + +### Create +
+s3:GetObject,
+appsync:CreateFunction
+ +### List +
+appsync:ListFunctions
+ + +## Example +```sql +SELECT +region, +function_arn +FROM awscc.appsync.function_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/index.md b/docs/awscc-docs/providers/awscc/appsync/index.md new file mode 100644 index 0000000000..d92691b395 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/index.md @@ -0,0 +1,47 @@ +--- +title: appsync +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The appsync service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+domain_name
+domain_name_api_association
+domain_name_api_associations
+domain_names
+function_configuration +
+
+function_configurations
+resolver
+resolvers
+source_api_association
+source_api_associations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/appsync/resolver/index.md b/docs/awscc-docs/providers/awscc/appsync/resolver/index.md new file mode 100644 index 0000000000..c258d78fc7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/resolver/index.md @@ -0,0 +1,98 @@ +--- +title: resolver +hide_title: false +hide_table_of_contents: false +keywords: + - resolver + - 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 +--- +Gets an individual resolver resource + +## Overview + + + + + +
Nameresolver
TypeResource
Descriptionresolver
Idawscc.appsync.resolver
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
api_idstringThe APSYlong GraphQL API to which you want to attach this resolver.
caching_configobjectThe caching configuration for the resolver.
codestringThe ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``.
code_s3_locationstringThe Amazon S3 endpoint.
data_source_namestringThe resolver data source name.
field_namestringThe GraphQL field on a type that invokes the resolver.
kindstringThe resolver type.<br/> + *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.<br/> + *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.
max_batch_sizeintegerThe maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.
pipeline_configobjectFunctions linked with the pipeline resolver.
request_mapping_templatestringThe request mapping template.<br/> Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
request_mapping_template_s3_locationstringThe 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.
resolver_arnstring
response_mapping_templatestringThe response mapping template.
response_mapping_template_s3_locationstringThe 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.
runtimeobjectDescribes 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.
sync_configobjectThe ``SyncConfig`` for a resolver attached to a versioned data source.
type_namestringThe GraphQL type that invokes this resolver.
metrics_configstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver resource, the following permissions are required: + +### Read +
+appsync:GetResolver
+ +### Update +
+s3:GetObject,
+appsync:UpdateResolver
+ +### Delete +
+appsync:DeleteResolver
+ + +## Example +```sql +SELECT +region, +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 awscc.appsync.resolver +WHERE region = 'us-east-1' +AND data__Identifier = '<ResolverArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/resolvers/index.md b/docs/awscc-docs/providers/awscc/appsync/resolvers/index.md new file mode 100644 index 0000000000..107f40f585 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/resolvers/index.md @@ -0,0 +1,60 @@ +--- +title: resolvers +hide_title: false +hide_table_of_contents: false +keywords: + - resolvers + - 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 +--- +Retrieves a list of resolvers in a region + +## Overview + + + + + +
Nameresolvers
TypeResource
Descriptionresolvers
Idawscc.appsync.resolvers
+ +## Fields + + + + + +
NameDatatypeDescription
resolver_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolvers resource, the following permissions are required: + +### Create +
+s3:GetObject,
+appsync:CreateResolver,
+appsync:GetResolver
+ +### List +
+appsync:ListResolvers
+ + +## Example +```sql +SELECT +region, +resolver_arn +FROM awscc.appsync.resolvers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/source_api_association/index.md b/docs/awscc-docs/providers/awscc/appsync/source_api_association/index.md new file mode 100644 index 0000000000..000469b4fb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/source_api_association/index.md @@ -0,0 +1,93 @@ +--- +title: source_api_association +hide_title: false +hide_table_of_contents: false +keywords: + - source_api_association + - 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 +--- +Gets an individual source_api_association resource + +## Overview + + + + + +
Namesource_api_association
TypeResource
Descriptionsource_api_association
Idawscc.appsync.source_api_association
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
source_api_identifierstringIdentifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
merged_api_identifierstringIdentifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
descriptionstringDescription of the SourceApiAssociation.
source_api_association_configundefinedCustomized configuration for SourceApiAssociation.
association_idstringId of the SourceApiAssociation.
association_arnstringARN of the SourceApiAssociation.
source_api_idstringGraphQLApiId of the source API in the association.
source_api_arnstringARN of the source API in the association.
merged_api_idstringGraphQLApiId of the Merged API in the association.
merged_api_arnstringARN of the Merged API in the association.
source_api_association_statusstringCurrent status of SourceApiAssociation.
source_api_association_status_detailstringCurrent SourceApiAssociation status details.
last_successful_merge_datestringDate of last schema successful merge.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the source_api_association resource, the following permissions are required: + +### Read +
+appsync:GetSourceApiAssociation,
+appsync:ListSourceApiAssociations
+ +### Update +
+appsync:GetSourceApiAssociation,
+appsync:UpdateSourceApiAssociation,
+appsync:GetSourceApiAssociation
+ +### Delete +
+appsync:GetSourceApiAssociation,
+appsync:DisassociateSourceGraphqlApi,
+appsync:DisassociateMergedGraphqlApi,
+appsync:ListSourceApiAssociations
+ + +## Example +```sql +SELECT +region, +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 awscc.appsync.source_api_association +WHERE region = 'us-east-1' +AND data__Identifier = '<AssociationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/appsync/source_api_associations/index.md b/docs/awscc-docs/providers/awscc/appsync/source_api_associations/index.md new file mode 100644 index 0000000000..07289ce6aa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/appsync/source_api_associations/index.md @@ -0,0 +1,60 @@ +--- +title: source_api_associations +hide_title: false +hide_table_of_contents: false +keywords: + - source_api_associations + - 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 +--- +Retrieves a list of source_api_associations in a region + +## Overview + + + + + +
Namesource_api_associations
TypeResource
Descriptionsource_api_associations
Idawscc.appsync.source_api_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_arnstringARN of the SourceApiAssociation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the source_api_associations resource, the following permissions are required: + +### Create +
+appsync:AssociateSourceGraphqlApi,
+appsync:AssociateMergedGraphqlApi,
+appsync:GetSourceApiAssociation
+ +### List +
+appsync:ListSourceApiAssociations
+ + +## Example +```sql +SELECT +region, +association_arn +FROM awscc.appsync.source_api_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/aps/index.md b/docs/awscc-docs/providers/awscc/aps/index.md new file mode 100644 index 0000000000..df06cf709a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/aps/index.md @@ -0,0 +1,41 @@ +--- +title: aps +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The aps service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+rule_groups_namespace
+rule_groups_namespaces +
+
+workspace
+workspaces +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/aps/rule_groups_namespace/index.md b/docs/awscc-docs/providers/awscc/aps/rule_groups_namespace/index.md new file mode 100644 index 0000000000..c9d2d785c9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/aps/rule_groups_namespace/index.md @@ -0,0 +1,77 @@ +--- +title: rule_groups_namespace +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_namespace + - 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 +--- +Gets an individual rule_groups_namespace resource + +## Overview + + + + + +
Namerule_groups_namespace
TypeResource
Descriptionrule_groups_namespace
Idawscc.aps.rule_groups_namespace
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
workspacestringRequired to identify a specific APS Workspace associated with this RuleGroupsNamespace.
namestringThe RuleGroupsNamespace name.
datastringThe RuleGroupsNamespace data.
arnstringThe RuleGroupsNamespace ARN.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule_groups_namespace resource, the following permissions are required: + +### Read +
+aps:DescribeRuleGroupsNamespace,
+aps:ListTagsForResource
+ +### Update +
+aps:PutRuleGroupsNamespace,
+aps:DescribeRuleGroupsNamespace,
+aps:TagResource,
+aps:UntagResource,
+aps:ListTagsForResource
+ +### Delete +
+aps:DeleteRuleGroupsNamespace,
+aps:DescribeRuleGroupsNamespace
+ + +## Example +```sql +SELECT +region, +workspace, +name, +data, +arn, +tags +FROM awscc.aps.rule_groups_namespace +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/aps/rule_groups_namespaces/index.md b/docs/awscc-docs/providers/awscc/aps/rule_groups_namespaces/index.md new file mode 100644 index 0000000000..362ef489c9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/aps/rule_groups_namespaces/index.md @@ -0,0 +1,61 @@ +--- +title: rule_groups_namespaces +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_namespaces + - 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 +--- +Retrieves a list of rule_groups_namespaces in a region + +## Overview + + + + + +
Namerule_groups_namespaces
TypeResource
Descriptionrule_groups_namespaces
Idawscc.aps.rule_groups_namespaces
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe RuleGroupsNamespace ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule_groups_namespaces resource, the following permissions are required: + +### Create +
+aps:CreateRuleGroupsNamespace,
+aps:DescribeRuleGroupsNamespace,
+aps:TagResource
+ +### List +
+aps:ListRuleGroupsNamespaces,
+aps:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.aps.rule_groups_namespaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/aps/workspace/index.md b/docs/awscc-docs/providers/awscc/aps/workspace/index.md new file mode 100644 index 0000000000..be0c8d3deb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/aps/workspace/index.md @@ -0,0 +1,101 @@ +--- +title: workspace +hide_title: false +hide_table_of_contents: false +keywords: + - workspace + - 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 +--- +Gets an individual workspace resource + +## Overview + + + + + +
Nameworkspace
TypeResource
Descriptionworkspace
Idawscc.aps.workspace
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
workspace_idstringRequired to identify a specific APS Workspace.
aliasstringAMP Workspace alias.
arnstringWorkspace arn.
alert_manager_definitionstringThe AMP Workspace alert manager definition data
prometheus_endpointstringAMP Workspace prometheus endpoint
logging_configurationobject
kms_key_arnstringKMS Key ARN used to encrypt and decrypt AMP workspace data.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workspace resource, the following permissions are required: + +### Read +
+aps:DescribeWorkspace,
+aps:ListTagsForResource,
+aps:DescribeAlertManagerDefinition,
+aps:DescribeLoggingConfiguration
+ +### Update +
+aps:UpdateWorkspaceAlias,
+aps:DescribeWorkspace,
+aps:TagResource,
+aps:UntagResource,
+aps:ListTagsForResource,
+aps:CreateAlertManagerDefinition,
+aps:PutAlertManagerDefinition,
+aps:DeleteAlertManagerDefinition,
+aps:CreateLoggingConfiguration,
+aps:DescribeLoggingConfiguration,
+aps:UpdateLoggingConfiguration,
+aps:DeleteLoggingConfiguration,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:ListLogDeliveries,
+logs:DeleteLogDelivery,
+logs:PutResourcePolicy
+ +### Delete +
+aps:DeleteWorkspace,
+aps:DescribeWorkspace,
+aps:DeleteAlertManagerDefinition,
+aps:DeleteLoggingConfiguration,
+logs:DeleteLogDelivery
+ + +## Example +```sql +SELECT +region, +workspace_id, +alias, +arn, +alert_manager_definition, +prometheus_endpoint, +logging_configuration, +kms_key_arn, +tags +FROM awscc.aps.workspace +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/aps/workspaces/index.md b/docs/awscc-docs/providers/awscc/aps/workspaces/index.md new file mode 100644 index 0000000000..ee8d9bc0a7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/aps/workspaces/index.md @@ -0,0 +1,71 @@ +--- +title: workspaces +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces + - 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 +--- +Retrieves a list of workspaces in a region + +## Overview + + + + + +
Nameworkspaces
TypeResource
Descriptionworkspaces
Idawscc.aps.workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringWorkspace arn.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workspaces resource, the following permissions are required: + +### Create +
+aps:CreateWorkspace,
+aps:DescribeWorkspace,
+aps:TagResource,
+aps:CreateAlertManagerDefinition,
+aps:DescribeAlertManagerDefinition,
+aps:CreateLoggingConfiguration,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+kms:CreateGrant,
+kms:Decrypt,
+kms:GenerateDataKey
+ +### List +
+aps:ListWorkspaces,
+aps:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.aps.workspaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/arczonalshift/index.md b/docs/awscc-docs/providers/awscc/arczonalshift/index.md new file mode 100644 index 0000000000..95e9761671 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/arczonalshift/index.md @@ -0,0 +1,39 @@ +--- +title: arczonalshift +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The arczonalshift service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+zonal_autoshift_configuration +
+
+zonal_autoshift_configurations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configuration/index.md b/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configuration/index.md new file mode 100644 index 0000000000..3729e828bd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configuration/index.md @@ -0,0 +1,72 @@ +--- +title: zonal_autoshift_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - zonal_autoshift_configuration + - 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 +--- +Gets an individual zonal_autoshift_configuration resource + +## Overview + + + + + +
Namezonal_autoshift_configuration
TypeResource
Descriptionzonal_autoshift_configuration
Idawscc.arczonalshift.zonal_autoshift_configuration
+ +## Fields + + + + + + + +
NameDatatypeDescription
zonal_autoshift_statusstring
practice_run_configurationobject
resource_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the zonal_autoshift_configuration resource, the following permissions are required: + +### Read +
+arc-zonal-shift:GetManagedResource
+ +### Update +
+arc-zonal-shift:GetManagedResource,
+arc-zonal-shift:UpdatePracticeRunConfiguration,
+arc-zonal-shift:UpdateZonalAutoshiftConfiguration,
+cloudwatch:DescribeAlarms
+ +### Delete +
+arc-zonal-shift:DeletePracticeRunConfiguration,
+arc-zonal-shift:GetManagedResource,
+arc-zonal-shift:UpdateZonalAutoshiftConfiguration
+ + +## Example +```sql +SELECT +region, +zonal_autoshift_status, +practice_run_configuration, +resource_identifier +FROM awscc.arczonalshift.zonal_autoshift_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configurations/index.md b/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configurations/index.md new file mode 100644 index 0000000000..aec3168bc3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configurations/index.md @@ -0,0 +1,62 @@ +--- +title: zonal_autoshift_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - zonal_autoshift_configurations + - 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 +--- +Retrieves a list of zonal_autoshift_configurations in a region + +## Overview + + + + + +
Namezonal_autoshift_configurations
TypeResource
Descriptionzonal_autoshift_configurations
Idawscc.arczonalshift.zonal_autoshift_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
resource_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the zonal_autoshift_configurations resource, the following permissions are required: + +### Create +
+arc-zonal-shift:CreatePracticeRunConfiguration,
+arc-zonal-shift:GetManagedResource,
+arc-zonal-shift:UpdateZonalAutoshiftConfiguration,
+cloudwatch:DescribeAlarms,
+iam:CreateServiceLinkedRole
+ +### List +
+arc-zonal-shift:ListManagedResources
+ + +## Example +```sql +SELECT +region, +resource_identifier +FROM awscc.arczonalshift.zonal_autoshift_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md b/docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md new file mode 100644 index 0000000000..ec9f872c30 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md @@ -0,0 +1,87 @@ +--- +title: capacity_reservation +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation + - 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 +--- +Gets an individual capacity_reservation resource + +## Overview + + + + + +
Namecapacity_reservation
TypeResource
Descriptioncapacity_reservation
Idawscc.athena.capacity_reservation
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe reservation name.
statusstringThe status of the reservation.
target_dpusintegerThe number of DPUs to request to be allocated to the reservation.
allocated_dpusintegerThe number of DPUs Athena has provisioned and allocated for the reservation
capacity_assignment_configurationobject
creation_timestringThe date and time the reservation was created.
last_successful_allocation_timestringThe timestamp when the last successful allocated was made
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the capacity_reservation resource, the following permissions are required: + +### Read +
+athena:GetCapacityReservation,
+athena:GetCapacityAssignmentConfiguration,
+athena:ListTagsForResource
+ +### Update +
+athena:UpdateCapacityReservation,
+athena:PutCapacityAssignmentConfiguration,
+athena:GetCapacityReservation,
+athena:TagResource,
+athena:UntagResource
+ +### Delete +
+athena:CancelCapacityReservation,
+athena:GetCapacityReservation,
+athena:DeleteCapacityReservation
+ + +## Example +```sql +SELECT +region, +arn, +name, +status, +target_dpus, +allocated_dpus, +capacity_assignment_configuration, +creation_time, +last_successful_allocation_time, +tags +FROM awscc.athena.capacity_reservation +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md b/docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md new file mode 100644 index 0000000000..16ad2d866b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md @@ -0,0 +1,62 @@ +--- +title: capacity_reservations +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservations + - 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 +--- +Retrieves a list of capacity_reservations in a region + +## Overview + + + + + +
Namecapacity_reservations
TypeResource
Descriptioncapacity_reservations
Idawscc.athena.capacity_reservations
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the capacity_reservations resource, the following permissions are required: + +### Create +
+athena:CreateCapacityReservation,
+athena:PutCapacityAssignmentConfiguration,
+athena:GetCapacityReservation,
+athena:TagResource
+ +### List +
+athena:ListCapacityReservations,
+athena:GetCapacityReservation
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.athena.capacity_reservations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/data_catalog/index.md b/docs/awscc-docs/providers/awscc/athena/data_catalog/index.md new file mode 100644 index 0000000000..87856f6d4f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/data_catalog/index.md @@ -0,0 +1,76 @@ +--- +title: data_catalog +hide_title: false +hide_table_of_contents: false +keywords: + - data_catalog + - 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 +--- +Gets an individual data_catalog resource + +## Overview + + + + + +
Namedata_catalog
TypeResource
Descriptiondata_catalog
Idawscc.athena.data_catalog
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringThe 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.
descriptionstringA description of the data catalog to be created.
parametersobjectSpecifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
tagsarrayA list of comma separated tags to add to the data catalog that is created.
typestringThe type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_catalog resource, the following permissions are required: + +### Read +
+athena:GetDataCatalog,
+athena:ListTagsForResource
+ +### Update +
+athena:UpdateDataCatalog,
+athena:TagResource,
+athena:GetDataCatalog,
+athena:UntagResource,
+athena:ListTagsForResource
+ +### Delete +
+athena:DeleteDataCatalog
+ + +## Example +```sql +SELECT +region, +name, +description, +parameters, +tags, +type +FROM awscc.athena.data_catalog +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md b/docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md new file mode 100644 index 0000000000..2cb39f27a7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md @@ -0,0 +1,59 @@ +--- +title: data_catalogs +hide_title: false +hide_table_of_contents: false +keywords: + - data_catalogs + - 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 +--- +Retrieves a list of data_catalogs in a region + +## Overview + + + + + +
Namedata_catalogs
TypeResource
Descriptiondata_catalogs
Idawscc.athena.data_catalogs
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_catalogs resource, the following permissions are required: + +### Create +
+athena:CreateDataCatalog,
+athena:TagResource
+ +### List +
+athena:ListDataCatalog
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.athena.data_catalogs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/index.md b/docs/awscc-docs/providers/awscc/athena/index.md new file mode 100644 index 0000000000..e856b3bbf1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/index.md @@ -0,0 +1,47 @@ +--- +title: athena +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The athena service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+capacity_reservation
+capacity_reservations
+data_catalog
+data_catalogs
+named_queries +
+
+named_query
+prepared_statement
+prepared_statements
+work_group
+work_groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/athena/named_queries/index.md b/docs/awscc-docs/providers/awscc/athena/named_queries/index.md new file mode 100644 index 0000000000..87f6a728c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/named_queries/index.md @@ -0,0 +1,58 @@ +--- +title: named_queries +hide_title: false +hide_table_of_contents: false +keywords: + - named_queries + - 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 +--- +Retrieves a list of named_queries in a region + +## Overview + + + + + +
Namenamed_queries
TypeResource
Descriptionnamed_queries
Idawscc.athena.named_queries
+ +## Fields + + + + + +
NameDatatypeDescription
named_query_idstringThe unique ID of the query.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the named_queries resource, the following permissions are required: + +### Create +
+athena:CreateNamedQuery
+ +### List +
+athena:ListNamedQueries
+ + +## Example +```sql +SELECT +region, +named_query_id +FROM awscc.athena.named_queries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/named_query/index.md b/docs/awscc-docs/providers/awscc/athena/named_query/index.md new file mode 100644 index 0000000000..babb2470c5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/named_query/index.md @@ -0,0 +1,69 @@ +--- +title: named_query +hide_title: false +hide_table_of_contents: false +keywords: + - named_query + - 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 +--- +Gets an individual named_query resource + +## Overview + + + + + +
Namenamed_query
TypeResource
Descriptionnamed_query
Idawscc.athena.named_query
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringThe query name.
databasestringThe database to which the query belongs.
descriptionstringThe query description.
query_stringstringThe contents of the query with all query statements.
work_groupstringThe name of the workgroup that contains the named query.
named_query_idstringThe unique ID of the query.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the named_query resource, the following permissions are required: + +### Read +
+athena:GetNamedQuery
+ +### Delete +
+athena:DeleteNamedQuery
+ + +## Example +```sql +SELECT +region, +name, +database, +description, +query_string, +work_group, +named_query_id +FROM awscc.athena.named_query +WHERE region = 'us-east-1' +AND data__Identifier = '<NamedQueryId>' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md b/docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md new file mode 100644 index 0000000000..9d37525d4d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md @@ -0,0 +1,71 @@ +--- +title: prepared_statement +hide_title: false +hide_table_of_contents: false +keywords: + - prepared_statement + - 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 +--- +Gets an individual prepared_statement resource + +## Overview + + + + + +
Nameprepared_statement
TypeResource
Descriptionprepared_statement
Idawscc.athena.prepared_statement
+ +## Fields + + + + + + + + +
NameDatatypeDescription
statement_namestringThe name of the prepared statement.
work_groupstringThe name of the workgroup to which the prepared statement belongs.
descriptionstringThe description of the prepared statement.
query_statementstringThe query string for the prepared statement.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the prepared_statement resource, the following permissions are required: + +### Read +
+athena:GetPreparedStatement
+ +### Update +
+athena:UpdatePreparedStatement
+ +### Delete +
+athena:DeletePreparedStatement,
+athena:GetPreparedStatement
+ + +## Example +```sql +SELECT +region, +statement_name, +work_group, +description, +query_statement +FROM awscc.athena.prepared_statement +WHERE region = 'us-east-1' +AND data__Identifier = '<StatementName>' +AND data__Identifier = '<WorkGroup>' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md b/docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md new file mode 100644 index 0000000000..e2ce97525e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md @@ -0,0 +1,61 @@ +--- +title: prepared_statements +hide_title: false +hide_table_of_contents: false +keywords: + - prepared_statements + - 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 +--- +Retrieves a list of prepared_statements in a region + +## Overview + + + + + +
Nameprepared_statements
TypeResource
Descriptionprepared_statements
Idawscc.athena.prepared_statements
+ +## Fields + + + + + + +
NameDatatypeDescription
statement_namestringThe name of the prepared statement.
work_groupstringThe name of the workgroup to which the prepared statement belongs.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the prepared_statements resource, the following permissions are required: + +### Create +
+athena:CreatePreparedStatement,
+athena:GetPreparedStatement
+ +### List +
+athena:ListPreparedStatements
+ + +## Example +```sql +SELECT +region, +statement_name, +work_group +FROM awscc.athena.prepared_statements +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/work_group/index.md b/docs/awscc-docs/providers/awscc/athena/work_group/index.md new file mode 100644 index 0000000000..c6eeaf85db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/work_group/index.md @@ -0,0 +1,92 @@ +--- +title: work_group +hide_title: false +hide_table_of_contents: false +keywords: + - work_group + - 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 +--- +Gets an individual work_group resource + +## Overview + + + + + +
Namework_group
TypeResource
Descriptionwork_group
Idawscc.athena.work_group
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe workGroup name.
descriptionstringThe workgroup description.
tagsarrayOne or more tags, separated by commas, that you want to attach to the workgroup as you create it
work_group_configurationobjectThe workgroup configuration
work_group_configuration_updatesobjectThe workgroup configuration update object
creation_timestringThe date and time the workgroup was created.
statestringThe state of the workgroup: ENABLED or DISABLED.
recursive_delete_optionbooleanThe option to delete the workgroup and its contents even if the workgroup contains any named queries.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the work_group resource, the following permissions are required: + +### Read +
+athena:GetWorkGroup,
+athena:ListTagsForResource
+ +### Delete +
+athena:DeleteWorkGroup,
+athena:GetWorkGroup,
+athena:UntagResource
+ +### Update +
+athena:UpdateWorkGroup,
+athena:TagResource,
+athena:UntagResource,
+iam:PassRole,
+s3:GetBucketLocation,
+s3:GetObject,
+s3:ListBucket,
+s3:ListBucketMultipartUploads,
+s3:AbortMultipartUpload,
+s3:PutObject,
+s3:ListMultipartUploadParts,
+kms:Decrypt,
+kms:GenerateDataKey
+ + +## Example +```sql +SELECT +region, +name, +description, +tags, +work_group_configuration, +work_group_configuration_updates, +creation_time, +state, +recursive_delete_option +FROM awscc.athena.work_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/athena/work_groups/index.md b/docs/awscc-docs/providers/awscc/athena/work_groups/index.md new file mode 100644 index 0000000000..92003bf8e2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/athena/work_groups/index.md @@ -0,0 +1,69 @@ +--- +title: work_groups +hide_title: false +hide_table_of_contents: false +keywords: + - work_groups + - 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 +--- +Retrieves a list of work_groups in a region + +## Overview + + + + + +
Namework_groups
TypeResource
Descriptionwork_groups
Idawscc.athena.work_groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe workGroup name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the work_groups resource, the following permissions are required: + +### Create +
+athena:CreateWorkGroup,
+athena:TagResource,
+iam:PassRole,
+s3:GetBucketLocation,
+s3:GetObject,
+s3:ListBucket,
+s3:ListBucketMultipartUploads,
+s3:AbortMultipartUpload,
+s3:PutObject,
+s3:ListMultipartUploadParts,
+kms:Decrypt,
+kms:GenerateDataKey
+ +### List +
+athena:ListWorkGroups
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.athena.work_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md b/docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md new file mode 100644 index 0000000000..9434fe694b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md @@ -0,0 +1,90 @@ +--- +title: assessment +hide_title: false +hide_table_of_contents: false +keywords: + - assessment + - 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 +--- +Gets an individual assessment resource + +## Overview + + + + + +
Nameassessment
TypeResource
Descriptionassessment
Idawscc.auditmanager.assessment
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
framework_idstring
assessment_idstring
aws_accountobject
arnstring
tagsarrayThe tags associated with the assessment.
delegationsarrayThe list of delegations.
rolesarrayThe list of roles for the specified assessment.
scopeobject
assessment_reports_destinationobject
statusstring
creation_timenumber
namestring
descriptionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assessment resource, the following permissions are required: + +### Read +
+auditmanager:GetAssessment
+ +### Update +
+auditmanager:UpdateAssessment,
+auditmanager:UpdateAssessmentStatus,
+auditmanager:BatchCreateDelegationByAssessment,
+auditmanager:BatchDeleteDelegationByAssessment
+ +### Delete +
+auditmanager:DeleteAssessment
+ + +## Example +```sql +SELECT +region, +framework_id, +assessment_id, +aws_account, +arn, +tags, +delegations, +roles, +scope, +assessment_reports_destination, +status, +creation_time, +name, +description +FROM awscc.auditmanager.assessment +WHERE region = 'us-east-1' +AND data__Identifier = '<AssessmentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md b/docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md new file mode 100644 index 0000000000..955d7bbcf2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md @@ -0,0 +1,62 @@ +--- +title: assessments +hide_title: false +hide_table_of_contents: false +keywords: + - assessments + - 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 +--- +Retrieves a list of assessments in a region + +## Overview + + + + + +
Nameassessments
TypeResource
Descriptionassessments
Idawscc.auditmanager.assessments
+ +## Fields + + + + + +
NameDatatypeDescription
assessment_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assessments resource, the following permissions are required: + +### Create +
+auditmanager:CreateAssessment,
+auditmanager:TagResource,
+auditmanager:ListTagsForResource,
+auditmanager:BatchCreateDelegationByAssessment,
+iam:PassRole
+ +### List +
+auditmanager:ListAssessments
+ + +## Example +```sql +SELECT +region, +assessment_id +FROM awscc.auditmanager.assessments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/auditmanager/index.md b/docs/awscc-docs/providers/awscc/auditmanager/index.md new file mode 100644 index 0000000000..dc3aac018d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/auditmanager/index.md @@ -0,0 +1,39 @@ +--- +title: auditmanager +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The auditmanager service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+assessment +
+
+assessments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_group/index.md b/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_group/index.md new file mode 100644 index 0000000000..593cd1097e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_group/index.md @@ -0,0 +1,137 @@ +--- +title: auto_scaling_group +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_group + - 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 +--- +Gets an individual auto_scaling_group resource + +## Overview + + + + + +
Nameauto_scaling_group
TypeResource
Descriptionauto_scaling_group
Idawscc.autoscaling.auto_scaling_group
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
lifecycle_hook_specification_listarray
load_balancer_namesarray
launch_configuration_namestring
service_linked_role_ar_nstring
target_group_ar_nsarray
cooldownstring
notification_configurationsarray
desired_capacitystring
health_check_grace_periodinteger
default_instance_warmupinteger
new_instances_protected_from_scale_inboolean
launch_templateobject
mixed_instances_policyobject
v_pc_zone_identifierarray
tagsarray
contextstring
capacity_rebalanceboolean
instance_idstring
availability_zonesarray
notification_configurationobject
metrics_collectionarray
instance_maintenance_policyobject
max_sizestring
min_sizestring
termination_policiesarray
auto_scaling_group_namestring
desired_capacity_typestring
placement_groupstring
health_check_typestring
max_instance_lifetimeinteger
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the auto_scaling_group resource, the following permissions are required: + +### Read +
+autoscaling:*,
+managed-fleets:GetAutoScalingGroup
+ +### Update +
+autoscaling:*,
+cloudwatch:PutMetricAlarm,
+ec2:Describe*,
+ec2:GetInstanceTypesFromInstanceRequirements,
+ec2:RunInstances,
+elasticloadbalancing:DescribeLoadBalancers,
+elasticloadbalancing:DescribeTargetGroups,
+iam:CreateServiceLinkedRole,
+iam:PassRole,
+managed-fleets:GetAutoScalingGroup,
+managed-fleets:RegisterAutoScalingGroup,
+managed-fleets:DeregisterAutoScalingGroup,
+managed-fleets:UpdateAutoScalingGroup,
+ssm:GetParameters
+ +### Delete +
+autoscaling:*,
+managed-fleets:GetAutoScalingGroup,
+managed-fleets:DeleteAutoScalingGroup
+ + +## Example +```sql +SELECT +region, +lifecycle_hook_specification_list, +load_balancer_names, +launch_configuration_name, +service_linked_role_ar_n, +target_group_ar_ns, +cooldown, +notification_configurations, +desired_capacity, +health_check_grace_period, +default_instance_warmup, +new_instances_protected_from_scale_in, +launch_template, +mixed_instances_policy, +v_pc_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 awscc.autoscaling.auto_scaling_group +WHERE region = 'us-east-1' +AND data__Identifier = '<AutoScalingGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_groups/index.md b/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_groups/index.md new file mode 100644 index 0000000000..ec79950156 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_groups/index.md @@ -0,0 +1,69 @@ +--- +title: auto_scaling_groups +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_groups + - 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 +--- +Retrieves a list of auto_scaling_groups in a region + +## Overview + + + + + +
Nameauto_scaling_groups
TypeResource
Descriptionauto_scaling_groups
Idawscc.autoscaling.auto_scaling_groups
+ +## Fields + + + + + +
NameDatatypeDescription
auto_scaling_group_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the auto_scaling_groups resource, the following permissions are required: + +### Create +
+autoscaling:*,
+cloudwatch:PutMetricAlarm,
+ec2:Describe*,
+ec2:GetInstanceTypesFromInstanceRequirements,
+ec2:RunInstances,
+elasticloadbalancing:DescribeLoadBalancers,
+elasticloadbalancing:DescribeTargetGroups,
+iam:CreateServiceLinkedRole,
+iam:PassRole,
+managed-fleets:GetAutoScalingGroup,
+managed-fleets:CreateAutoScalingGroup,
+ssm:GetParameters
+ +### List +
+autoscaling:*
+ + +## Example +```sql +SELECT +region, +auto_scaling_group_name +FROM awscc.autoscaling.auto_scaling_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/index.md b/docs/awscc-docs/providers/awscc/autoscaling/index.md new file mode 100644 index 0000000000..a5a4d03cb2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/index.md @@ -0,0 +1,49 @@ +--- +title: autoscaling +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The autoscaling service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+auto_scaling_group
+auto_scaling_groups
+launch_configuration
+launch_configurations
+lifecycle_hook
+lifecycle_hooks +
+
+scaling_policies
+scaling_policy
+scheduled_action
+scheduled_actions
+warm_pool
+warm_pools +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/autoscaling/launch_configuration/index.md b/docs/awscc-docs/providers/awscc/autoscaling/launch_configuration/index.md new file mode 100644 index 0000000000..e1466cb2b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/launch_configuration/index.md @@ -0,0 +1,96 @@ +--- +title: launch_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - launch_configuration + - 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 +--- +Gets an individual launch_configuration resource + +## Overview + + + + + +
Namelaunch_configuration
TypeResource
Descriptionlaunch_configuration
Idawscc.autoscaling.launch_configuration
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
associate_public_ip_addressbooleanFor 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.
block_device_mappingsarraySpecifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
classic_link_vp_cidstringThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
classic_link_vp_csecurity_groupsarrayThe IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.
ebs_optimizedbooleanSpecifies whether the launch configuration is optimized for EBS I/O (true) or not (false).
iam_instance_profilestringProvides 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.
image_idstringProvides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
instance_idstringThe ID of the Amazon EC2 instance you want to use to create the launch configuration.
instance_monitoringbooleanControls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
instance_typestringSpecifies the instance type of the EC2 instance.
kernel_idstringProvides the ID of the kernel associated with the EC2 AMI.
key_namestringProvides the name of the EC2 key pair.
launch_configuration_namestringThe name of the launch configuration. This name must be unique per Region per account.
metadata_optionsobjectThe metadata options for the instances.
placement_tenancystringThe tenancy of the instance, either default or dedicated.
ram_disk_idstringThe ID of the RAM disk to select.
security_groupsarrayA list that contains the security groups to assign to the instances in the Auto Scaling group.
spot_pricestringThe maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.
user_datastringThe Base64-encoded user data to make available to the launched EC2 instances.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the launch_configuration resource, the following permissions are required: + +### Read +
+autoscaling:DescribeLaunchConfigurations
+ +### Delete +
+autoscaling:DeleteLaunchConfiguration,
+autoscaling:DescribeLaunchConfigurations
+ + +## Example +```sql +SELECT +region, +associate_public_ip_address, +block_device_mappings, +classic_link_vp_cid, +classic_link_vp_csecurity_groups, +ebs_optimized, +iam_instance_profile, +image_id, +instance_id, +instance_monitoring, +instance_type, +kernel_id, +key_name, +launch_configuration_name, +metadata_options, +placement_tenancy, +ram_disk_id, +security_groups, +spot_price, +user_data +FROM awscc.autoscaling.launch_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<LaunchConfigurationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md b/docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md new file mode 100644 index 0000000000..2edd1ff628 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: launch_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - launch_configurations + - 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 +--- +Retrieves a list of launch_configurations in a region + +## Overview + + + + + +
Namelaunch_configurations
TypeResource
Descriptionlaunch_configurations
Idawscc.autoscaling.launch_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
launch_configuration_namestringThe name of the launch configuration. This name must be unique per Region per account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the launch_configurations resource, the following permissions are required: + +### Create +
+autoscaling:CreateLaunchConfiguration,
+autoscaling:DescribeLaunchConfigurations,
+iam:PassRole
+ +### List +
+autoscaling:DescribeLaunchConfigurations
+ + +## Example +```sql +SELECT +region, +launch_configuration_name +FROM awscc.autoscaling.launch_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md b/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md new file mode 100644 index 0000000000..aad38be0fe --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md @@ -0,0 +1,81 @@ +--- +title: lifecycle_hook +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_hook + - 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 +--- +Gets an individual lifecycle_hook resource + +## Overview + + + + + +
Namelifecycle_hook
TypeResource
Descriptionlifecycle_hook
Idawscc.autoscaling.lifecycle_hook
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
auto_scaling_group_namestringThe name of the Auto Scaling group for the lifecycle hook.
default_resultstringThe 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).
heartbeat_timeoutintegerThe 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.
lifecycle_hook_namestringThe name of the lifecycle hook.
lifecycle_transitionstringThe instance state to which you want to attach the lifecycle hook.
notification_metadatastringAdditional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
notification_target_ar_nstringThe 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.
role_ar_nstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the lifecycle_hook resource, the following permissions are required: + +### Read +
+autoscaling:DescribeLifecycleHooks
+ +### Update +
+autoscaling:PutLifecycleHook,
+autoscaling:DescribeLifecycleHooks,
+iam:PassRole
+ +### Delete +
+autoscaling:DeleteLifecycleHook,
+autoscaling:DescribeLifecycleHooks
+ + +## Example +```sql +SELECT +region, +auto_scaling_group_name, +default_result, +heartbeat_timeout, +lifecycle_hook_name, +lifecycle_transition, +notification_metadata, +notification_target_ar_n, +role_ar_n +FROM awscc.autoscaling.lifecycle_hook +WHERE region = 'us-east-1' +AND data__Identifier = '<AutoScalingGroupName>' +AND data__Identifier = '<LifecycleHookName>' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md b/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md new file mode 100644 index 0000000000..980946915b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md @@ -0,0 +1,62 @@ +--- +title: lifecycle_hooks +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_hooks + - 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 +--- +Retrieves a list of lifecycle_hooks in a region + +## Overview + + + + + +
Namelifecycle_hooks
TypeResource
Descriptionlifecycle_hooks
Idawscc.autoscaling.lifecycle_hooks
+ +## Fields + + + + + + +
NameDatatypeDescription
auto_scaling_group_namestringThe name of the Auto Scaling group for the lifecycle hook.
lifecycle_hook_namestringThe name of the lifecycle hook.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the lifecycle_hooks resource, the following permissions are required: + +### Create +
+autoscaling:PutLifecycleHook,
+autoscaling:DescribeLifecycleHooks,
+iam:PassRole
+ +### List +
+autoscaling:DescribeLifecycleHooks
+ + +## Example +```sql +SELECT +region, +auto_scaling_group_name, +lifecycle_hook_name +FROM awscc.autoscaling.lifecycle_hooks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md new file mode 100644 index 0000000000..471bf5d70d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md @@ -0,0 +1,60 @@ +--- +title: scaling_policies +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policies + - 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 +--- +Retrieves a list of scaling_policies in a region + +## Overview + + + + + +
Namescaling_policies
TypeResource
Descriptionscaling_policies
Idawscc.autoscaling.scaling_policies
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the AutoScaling scaling policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scaling_policies resource, the following permissions are required: + +### Create +
+autoscaling:DescribePolicies,
+autoscaling:PutScalingPolicy,
+cloudwatch:GetMetricData
+ +### List +
+autoscaling:DescribePolicies
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.autoscaling.scaling_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md new file mode 100644 index 0000000000..e51cd39ff2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md @@ -0,0 +1,90 @@ +--- +title: scaling_policy +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policy + - 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 +--- +Gets an individual scaling_policy resource + +## Overview + + + + + +
Namescaling_policy
TypeResource
Descriptionscaling_policy
Idawscc.autoscaling.scaling_policy
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
metric_aggregation_typestringThe 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.
policy_namestring
policy_typestringOne of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
predictive_scaling_configurationobjectA predictive scaling policy. Includes support for predefined metrics only.
scaling_adjustmentintegerThe 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.)
cooldownstringThe 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.
step_adjustmentsarrayA 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.)
auto_scaling_group_namestringThe name of the Auto Scaling group.
min_adjustment_magnitudeintegerThe 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.
target_tracking_configurationobjectA target tracking scaling policy. Includes support for predefined or customized metrics.
estimated_instance_warmupintegerThe 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.
adjustment_typestringSpecifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
arnstringThe ARN of the AutoScaling scaling policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scaling_policy resource, the following permissions are required: + +### Read +
+autoscaling:DescribePolicies
+ +### Update +
+autoscaling:DescribePolicies,
+autoscaling:PutScalingPolicy,
+cloudwatch:GetMetricData
+ +### Delete +
+autoscaling:DeletePolicy,
+autoscaling:DescribePolicies
+ + +## Example +```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 awscc.autoscaling.scaling_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md new file mode 100644 index 0000000000..a31771a858 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md @@ -0,0 +1,81 @@ +--- +title: scheduled_action +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_action + - 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 +--- +Gets an individual scheduled_action resource + +## Overview + + + + + +
Namescheduled_action
TypeResource
Descriptionscheduled_action
Idawscc.autoscaling.scheduled_action
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
scheduled_action_namestringAuto-generated unique identifier
min_sizeintegerThe minimum size of the Auto Scaling group.
recurrencestringThe 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.
time_zonestringThe time zone for the cron expression.
end_timestringThe latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
auto_scaling_group_namestringThe name of the Auto Scaling group.
start_timestringThe earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
desired_capacityintegerThe desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
max_sizeintegerThe minimum size of the Auto Scaling group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_action resource, the following permissions are required: + +### Read +
+autoscaling:DescribeScheduledActions
+ +### Update +
+autoscaling:PutScheduledUpdateGroupAction
+ +### Delete +
+autoscaling:DeleteScheduledAction,
+autoscaling:DescribeScheduledActions
+ + +## Example +```sql +SELECT +region, +scheduled_action_name, +min_size, +recurrence, +time_zone, +end_time, +auto_scaling_group_name, +start_time, +desired_capacity, +max_size +FROM awscc.autoscaling.scheduled_action +WHERE region = 'us-east-1' +AND data__Identifier = '<ScheduledActionName>' +AND data__Identifier = '<AutoScalingGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md new file mode 100644 index 0000000000..ce7f8d1ab7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md @@ -0,0 +1,61 @@ +--- +title: scheduled_actions +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_actions + - 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 +--- +Retrieves a list of scheduled_actions in a region + +## Overview + + + + + +
Namescheduled_actions
TypeResource
Descriptionscheduled_actions
Idawscc.autoscaling.scheduled_actions
+ +## Fields + + + + + + +
NameDatatypeDescription
scheduled_action_namestringAuto-generated unique identifier
auto_scaling_group_namestringThe name of the Auto Scaling group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_actions resource, the following permissions are required: + +### Create +
+autoscaling:PutScheduledUpdateGroupAction,
+autoscaling:DescribeScheduledActions
+ +### List +
+autoscaling:DescribeScheduledActions
+ + +## Example +```sql +SELECT +region, +scheduled_action_name, +auto_scaling_group_name +FROM awscc.autoscaling.scheduled_actions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md b/docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md new file mode 100644 index 0000000000..52545d64b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md @@ -0,0 +1,74 @@ +--- +title: warm_pool +hide_title: false +hide_table_of_contents: false +keywords: + - warm_pool + - 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 +--- +Gets an individual warm_pool resource + +## Overview + + + + + +
Namewarm_pool
TypeResource
Descriptionwarm_pool
Idawscc.autoscaling.warm_pool
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
auto_scaling_group_namestring
max_group_prepared_capacityinteger
min_sizeinteger
pool_statestring
instance_reuse_policyobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the warm_pool resource, the following permissions are required: + +### Delete +
+autoscaling:DeleteWarmPool,
+autoscaling:DescribeWarmPool
+ +### Read +
+autoscaling:DescribeWarmPool
+ +### Update +
+autoscaling:PutWarmPool,
+autoscaling:DescribeWarmPool,
+autoscaling:DescribeAutoScalingGroups
+ + +## Example +```sql +SELECT +region, +auto_scaling_group_name, +max_group_prepared_capacity, +min_size, +pool_state, +instance_reuse_policy +FROM awscc.autoscaling.warm_pool +WHERE region = 'us-east-1' +AND data__Identifier = '<AutoScalingGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/autoscaling/warm_pools/index.md b/docs/awscc-docs/providers/awscc/autoscaling/warm_pools/index.md new file mode 100644 index 0000000000..4f2a19406a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/autoscaling/warm_pools/index.md @@ -0,0 +1,56 @@ +--- +title: warm_pools +hide_title: false +hide_table_of_contents: false +keywords: + - warm_pools + - 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 +--- +Retrieves a list of warm_pools in a region + +## Overview + + + + + +
Namewarm_pools
TypeResource
Descriptionwarm_pools
Idawscc.autoscaling.warm_pools
+ +## Fields + + + + + +
NameDatatypeDescription
auto_scaling_group_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the warm_pools resource, the following permissions are required: + +### Create +
+autoscaling:PutWarmPool,
+autoscaling:DescribeWarmPool,
+autoscaling:DescribeAutoScalingGroups
+ + +## Example +```sql +SELECT +region, +auto_scaling_group_name +FROM awscc.autoscaling.warm_pools +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md b/docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md new file mode 100644 index 0000000000..300fa770c0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md @@ -0,0 +1,73 @@ +--- +title: capabilities +hide_title: false +hide_table_of_contents: false +keywords: + - capabilities + - 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 +--- +Retrieves a list of capabilities in a region + +## Overview + + + + + +
Namecapabilities
TypeResource
Descriptioncapabilities
Idawscc.b2bi.capabilities
+ +## Fields + + + + + +
NameDatatypeDescription
capability_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the capabilities resource, the following permissions are required: + +### Create +
+b2bi:CreateCapability,
+b2bi:TagResource,
+events:ListRules,
+events:PutRule,
+events:PutTargets,
+logs:CreateLogDelivery,
+logs:CreateLogGroup,
+logs:CreateLogStream,
+logs:DescribeLogGroups,
+logs:DescribeLogStreams,
+logs:DescribeResourcePolicies,
+logs:ListLogDeliveries,
+logs:PutLogEvents,
+logs:PutResourcePolicy,
+s3:GetObject,
+s3:ListBucket
+ +### List +
+b2bi:ListCapabilities
+ + +## Example +```sql +SELECT +region, +capability_id +FROM awscc.b2bi.capabilities +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/capability/index.md b/docs/awscc-docs/providers/awscc/b2bi/capability/index.md new file mode 100644 index 0000000000..17bb0521d4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/capability/index.md @@ -0,0 +1,82 @@ +--- +title: capability +hide_title: false +hide_table_of_contents: false +keywords: + - capability + - 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 +--- +Gets an individual capability resource + +## Overview + + + + + +
Namecapability
TypeResource
Descriptioncapability
Idawscc.b2bi.capability
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
capability_arnstring
capability_idstring
configurationundefined
created_atstring
instructions_documentsarray
modified_atstring
namestring
tagsarray
typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the capability resource, the following permissions are required: + +### Read +
+b2bi:GetCapability,
+b2bi:ListTagsForResource
+ +### Update +
+b2bi:TagResource,
+b2bi:UntagResource,
+b2bi:UpdateCapability
+ +### Delete +
+b2bi:DeleteCapability
+ + +## Example +```sql +SELECT +region, +capability_arn, +capability_id, +configuration, +created_at, +instructions_documents, +modified_at, +name, +tags, +type +FROM awscc.b2bi.capability +WHERE region = 'us-east-1' +AND data__Identifier = '<CapabilityId>' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/index.md b/docs/awscc-docs/providers/awscc/b2bi/index.md new file mode 100644 index 0000000000..bb7085c8b8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/index.md @@ -0,0 +1,45 @@ +--- +title: b2bi +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The b2bi service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+capabilities
+capability
+partnership
+partnerships +
+
+profile
+profiles
+transformer
+transformers +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/b2bi/partnership/index.md b/docs/awscc-docs/providers/awscc/b2bi/partnership/index.md new file mode 100644 index 0000000000..14a0458ec9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/partnership/index.md @@ -0,0 +1,86 @@ +--- +title: partnership +hide_title: false +hide_table_of_contents: false +keywords: + - partnership + - 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 +--- +Gets an individual partnership resource + +## Overview + + + + + +
Namepartnership
TypeResource
Descriptionpartnership
Idawscc.b2bi.partnership
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
capabilitiesarray
created_atstring
emailstring
modified_atstring
namestring
partnership_arnstring
partnership_idstring
phonestring
profile_idstring
tagsarray
trading_partner_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the partnership resource, the following permissions are required: + +### Read +
+b2bi:GetPartnership,
+b2bi:ListTagsForResource
+ +### Update +
+b2bi:TagResource,
+b2bi:UntagResource,
+b2bi:UpdatePartnership
+ +### Delete +
+b2bi:DeletePartnership
+ + +## Example +```sql +SELECT +region, +capabilities, +created_at, +email, +modified_at, +name, +partnership_arn, +partnership_id, +phone, +profile_id, +tags, +trading_partner_id +FROM awscc.b2bi.partnership +WHERE region = 'us-east-1' +AND data__Identifier = '<PartnershipId>' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md b/docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md new file mode 100644 index 0000000000..f35df6e655 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md @@ -0,0 +1,60 @@ +--- +title: partnerships +hide_title: false +hide_table_of_contents: false +keywords: + - partnerships + - 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 +--- +Retrieves a list of partnerships in a region + +## Overview + + + + + +
Namepartnerships
TypeResource
Descriptionpartnerships
Idawscc.b2bi.partnerships
+ +## Fields + + + + + +
NameDatatypeDescription
partnership_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the partnerships resource, the following permissions are required: + +### Create +
+b2bi:CreatePartnership,
+b2bi:TagResource,
+s3:PutObject
+ +### List +
+b2bi:ListPartnerships
+ + +## Example +```sql +SELECT +region, +partnership_id +FROM awscc.b2bi.partnerships +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/profile/index.md b/docs/awscc-docs/providers/awscc/b2bi/profile/index.md new file mode 100644 index 0000000000..f8bf34bd11 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/profile/index.md @@ -0,0 +1,88 @@ +--- +title: profile +hide_title: false +hide_table_of_contents: false +keywords: + - profile + - 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 +--- +Gets an individual profile resource + +## Overview + + + + + +
Nameprofile
TypeResource
Descriptionprofile
Idawscc.b2bi.profile
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
business_namestring
created_atstring
emailstring
log_group_namestring
loggingstring
modified_atstring
namestring
phonestring
profile_arnstring
profile_idstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profile resource, the following permissions are required: + +### Read +
+b2bi:GetProfile,
+b2bi:ListTagsForResource
+ +### Update +
+b2bi:TagResource,
+b2bi:UntagResource,
+b2bi:UpdateProfile
+ +### Delete +
+b2bi:DeleteProfile,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries
+ + +## Example +```sql +SELECT +region, +business_name, +created_at, +email, +log_group_name, +logging, +modified_at, +name, +phone, +profile_arn, +profile_id, +tags +FROM awscc.b2bi.profile +WHERE region = 'us-east-1' +AND data__Identifier = '<ProfileId>' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/profiles/index.md b/docs/awscc-docs/providers/awscc/b2bi/profiles/index.md new file mode 100644 index 0000000000..94e327daa4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/profiles/index.md @@ -0,0 +1,68 @@ +--- +title: profiles +hide_title: false +hide_table_of_contents: false +keywords: + - profiles + - 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 +--- +Retrieves a list of profiles in a region + +## Overview + + + + + +
Nameprofiles
TypeResource
Descriptionprofiles
Idawscc.b2bi.profiles
+ +## Fields + + + + + +
NameDatatypeDescription
profile_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +
+b2bi:CreateProfile,
+b2bi:TagResource,
+logs:CreateLogDelivery,
+logs:CreateLogGroup,
+logs:CreateLogStream,
+logs:DescribeLogGroups,
+logs:DescribeLogStreams,
+logs:DescribeResourcePolicies,
+logs:ListLogDeliveries,
+logs:PutLogEvents,
+logs:PutResourcePolicy
+ +### List +
+b2bi:ListProfiles
+ + +## Example +```sql +SELECT +region, +profile_id +FROM awscc.b2bi.profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/transformer/index.md b/docs/awscc-docs/providers/awscc/b2bi/transformer/index.md new file mode 100644 index 0000000000..f299096438 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/transformer/index.md @@ -0,0 +1,88 @@ +--- +title: transformer +hide_title: false +hide_table_of_contents: false +keywords: + - transformer + - 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 +--- +Gets an individual transformer resource + +## Overview + + + + + +
Nametransformer
TypeResource
Descriptiontransformer
Idawscc.b2bi.transformer
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
created_atstring
edi_typeundefined
file_formatstring
mapping_templatestring
modified_atstring
namestring
sample_documentstring
statusstring
tagsarray
transformer_arnstring
transformer_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transformer resource, the following permissions are required: + +### Read +
+b2bi:GetTransformer,
+b2bi:ListTagsForResource
+ +### Update +
+b2bi:TagResource,
+b2bi:UntagResource,
+b2bi:UpdateTransformer
+ +### Delete +
+b2bi:DeleteTransformer,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries
+ + +## Example +```sql +SELECT +region, +created_at, +edi_type, +file_format, +mapping_template, +modified_at, +name, +sample_document, +status, +tags, +transformer_arn, +transformer_id +FROM awscc.b2bi.transformer +WHERE region = 'us-east-1' +AND data__Identifier = '<TransformerId>' +``` diff --git a/docs/awscc-docs/providers/awscc/b2bi/transformers/index.md b/docs/awscc-docs/providers/awscc/b2bi/transformers/index.md new file mode 100644 index 0000000000..fd52b0035b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/b2bi/transformers/index.md @@ -0,0 +1,69 @@ +--- +title: transformers +hide_title: false +hide_table_of_contents: false +keywords: + - transformers + - 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 +--- +Retrieves a list of transformers in a region + +## Overview + + + + + +
Nametransformers
TypeResource
Descriptiontransformers
Idawscc.b2bi.transformers
+ +## Fields + + + + + +
NameDatatypeDescription
transformer_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transformers resource, the following permissions are required: + +### Create +
+b2bi:CreateTransformer,
+b2bi:TagResource,
+b2bi:UpdateTransformer,
+logs:CreateLogDelivery,
+logs:CreateLogGroup,
+logs:CreateLogStream,
+logs:DescribeLogGroups,
+logs:DescribeLogStreams,
+logs:DescribeResourcePolicies,
+logs:ListLogDeliveries,
+logs:PutLogEvents,
+logs:PutResourcePolicy
+ +### List +
+b2bi:ListTransformers
+ + +## Example +```sql +SELECT +region, +transformer_id +FROM awscc.b2bi.transformers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/backup_plan/index.md b/docs/awscc-docs/providers/awscc/backup/backup_plan/index.md new file mode 100644 index 0000000000..70caaa9c43 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/backup_plan/index.md @@ -0,0 +1,76 @@ +--- +title: backup_plan +hide_title: false +hide_table_of_contents: false +keywords: + - backup_plan + - 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 +--- +Gets an individual backup_plan resource + +## Overview + + + + + +
Namebackup_plan
TypeResource
Descriptionbackup_plan
Idawscc.backup.backup_plan
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
backup_planobject
backup_plan_tagsobject
backup_plan_arnstring
backup_plan_idstring
version_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the backup_plan resource, the following permissions are required: + +### Read +
+backup:GetBackupPlan,
+backup:ListTags
+ +### Delete +
+backup:GetBackupPlan,
+backup:DeleteBackupPlan
+ +### Update +
+backup:UpdateBackupPlan,
+backup:ListTags,
+backup:TagResource,
+backup:UntagResource
+ + +## Example +```sql +SELECT +region, +backup_plan, +backup_plan_tags, +backup_plan_arn, +backup_plan_id, +version_id +FROM awscc.backup.backup_plan +WHERE region = 'us-east-1' +AND data__Identifier = '<BackupPlanId>' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/backup_plans/index.md b/docs/awscc-docs/providers/awscc/backup/backup_plans/index.md new file mode 100644 index 0000000000..c82af8d429 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/backup_plans/index.md @@ -0,0 +1,60 @@ +--- +title: backup_plans +hide_title: false +hide_table_of_contents: false +keywords: + - backup_plans + - 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 +--- +Retrieves a list of backup_plans in a region + +## Overview + + + + + +
Namebackup_plans
TypeResource
Descriptionbackup_plans
Idawscc.backup.backup_plans
+ +## Fields + + + + + +
NameDatatypeDescription
backup_plan_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the backup_plans resource, the following permissions are required: + +### Create +
+backup:GetBackupPlan,
+backup:TagResource,
+backup:CreateBackupPlan
+ +### List +
+backup:ListBackupPlans
+ + +## Example +```sql +SELECT +region, +backup_plan_id +FROM awscc.backup.backup_plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/backup_selection/index.md b/docs/awscc-docs/providers/awscc/backup/backup_selection/index.md new file mode 100644 index 0000000000..345c45eb29 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/backup_selection/index.md @@ -0,0 +1,66 @@ +--- +title: backup_selection +hide_title: false +hide_table_of_contents: false +keywords: + - backup_selection + - 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 +--- +Gets an individual backup_selection resource + +## Overview + + + + + +
Namebackup_selection
TypeResource
Descriptionbackup_selection
Idawscc.backup.backup_selection
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
backup_plan_idstring
backup_selectionobject
selection_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the backup_selection resource, the following permissions are required: + +### Delete +
+backup:GetBackupSelection,
+backup:DeleteBackupSelection
+ +### Read +
+backup:GetBackupSelection
+ + +## Example +```sql +SELECT +region, +id, +backup_plan_id, +backup_selection, +selection_id +FROM awscc.backup.backup_selection +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/backup_selections/index.md b/docs/awscc-docs/providers/awscc/backup/backup_selections/index.md new file mode 100644 index 0000000000..7e3471336d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/backup_selections/index.md @@ -0,0 +1,61 @@ +--- +title: backup_selections +hide_title: false +hide_table_of_contents: false +keywords: + - backup_selections + - 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 +--- +Retrieves a list of backup_selections in a region + +## Overview + + + + + +
Namebackup_selections
TypeResource
Descriptionbackup_selections
Idawscc.backup.backup_selections
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the backup_selections resource, the following permissions are required: + +### Create +
+backup:CreateBackupSelection,
+iam:GetRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole
+ +### List +
+backup:ListBackupSelections
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.backup.backup_selections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/backup_vault/index.md b/docs/awscc-docs/providers/awscc/backup/backup_vault/index.md new file mode 100644 index 0000000000..3dc30ec23c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/backup_vault/index.md @@ -0,0 +1,87 @@ +--- +title: backup_vault +hide_title: false +hide_table_of_contents: false +keywords: + - backup_vault + - 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 +--- +Gets an individual backup_vault resource + +## Overview + + + + + +
Namebackup_vault
TypeResource
Descriptionbackup_vault
Idawscc.backup.backup_vault
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
access_policyobject
backup_vault_namestring
backup_vault_tagsobject
encryption_key_arnstring
notificationsobject
lock_configurationobject
backup_vault_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the backup_vault resource, the following permissions are required: + +### Read +
+backup:DescribeBackupVault,
+backup:GetBackupVaultNotifications,
+backup:GetBackupVaultAccessPolicy,
+backup:ListTags
+ +### Update +
+backup:DescribeBackupVault,
+backup:DeleteBackupVaultAccessPolicy,
+backup:DeleteBackupVaultNotifications,
+backup:DeleteBackupVaultLockConfiguration,
+backup:ListTags,
+backup:TagResource,
+backup:UntagResource,
+backup:PutBackupVaultAccessPolicy,
+backup:PutBackupVaultNotifications,
+backup:PutBackupVaultLockConfiguration
+ +### Delete +
+backup:DeleteBackupVault
+ + +## Example +```sql +SELECT +region, +access_policy, +backup_vault_name, +backup_vault_tags, +encryption_key_arn, +notifications, +lock_configuration, +backup_vault_arn +FROM awscc.backup.backup_vault +WHERE region = 'us-east-1' +AND data__Identifier = '<BackupVaultName>' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md b/docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md new file mode 100644 index 0000000000..0a9e153871 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md @@ -0,0 +1,69 @@ +--- +title: backup_vaults +hide_title: false +hide_table_of_contents: false +keywords: + - backup_vaults + - 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 +--- +Retrieves a list of backup_vaults in a region + +## Overview + + + + + +
Namebackup_vaults
TypeResource
Descriptionbackup_vaults
Idawscc.backup.backup_vaults
+ +## Fields + + + + + +
NameDatatypeDescription
backup_vault_nameundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the backup_vaults resource, the following permissions are required: + +### Create +
+backup:TagResource,
+backup:CreateBackupVault,
+backup:PutBackupVaultAccessPolicy,
+backup:PutBackupVaultNotifications,
+backup:PutBackupVaultLockConfiguration,
+backup-storage:Mount,
+backup-storage:MountCapsule,
+kms:CreateGrant,
+kms:GenerateDataKey,
+kms:Decrypt,
+kms:RetireGrant,
+kms:DescribeKey
+ +### List +
+backup:ListBackupVaults
+ + +## Example +```sql +SELECT +region, +backup_vault_name +FROM awscc.backup.backup_vaults +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/framework/index.md b/docs/awscc-docs/providers/awscc/backup/framework/index.md new file mode 100644 index 0000000000..aed893b959 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/framework/index.md @@ -0,0 +1,83 @@ +--- +title: framework +hide_title: false +hide_table_of_contents: false +keywords: + - framework + - 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 +--- +Gets an individual framework resource + +## Overview + + + + + +
Nameframework
TypeResource
Descriptionframework
Idawscc.backup.framework
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
framework_namestringThe 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 (_).
framework_descriptionstringAn optional description of the framework with a maximum 1,024 characters.
framework_arnstringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
deployment_statusstringThe deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
creation_timestringThe 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.
framework_controlsarrayContains detailed information about all of the controls of a framework. Each framework must contain at least one control.
framework_statusstringA 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:<br/><br/>`ACTIVE` when recording is turned on for all resources governed by the framework.<br/><br/>`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.<br/><br/>`INACTIVE` when recording is turned off for all resources governed by the framework.<br/><br/>`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.
framework_tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the framework resource, the following permissions are required: + +### Read +
+backup:DescribeFramework,
+backup:ListTags
+ +### Update +
+backup:DescribeFramework,
+backup:UpdateFramework,
+backup:ListTags,
+backup:TagResource,
+backup:UntagResource
+ +### Delete +
+backup:DeleteFramework,
+backup:DescribeFramework
+ + +## Example +```sql +SELECT +region, +framework_name, +framework_description, +framework_arn, +deployment_status, +creation_time, +framework_controls, +framework_status, +framework_tags +FROM awscc.backup.framework +WHERE region = 'us-east-1' +AND data__Identifier = '<FrameworkArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/frameworks/index.md b/docs/awscc-docs/providers/awscc/backup/frameworks/index.md new file mode 100644 index 0000000000..9471096814 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/frameworks/index.md @@ -0,0 +1,62 @@ +--- +title: frameworks +hide_title: false +hide_table_of_contents: false +keywords: + - frameworks + - 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 +--- +Retrieves a list of frameworks in a region + +## Overview + + + + + +
Nameframeworks
TypeResource
Descriptionframeworks
Idawscc.backup.frameworks
+ +## Fields + + + + + +
NameDatatypeDescription
framework_arnstringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the frameworks resource, the following permissions are required: + +### Create +
+backup:CreateFramework,
+backup:DescribeFramework,
+backup:ListTags,
+backup:TagResource,
+iam:CreateServiceLinkedRole
+ +### List +
+backup:ListFrameworks
+ + +## Example +```sql +SELECT +region, +framework_arn +FROM awscc.backup.frameworks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/index.md b/docs/awscc-docs/providers/awscc/backup/index.md new file mode 100644 index 0000000000..bf5ad0a664 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/index.md @@ -0,0 +1,51 @@ +--- +title: backup +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The backup service documentation. + +:::info Service Summary + +
+
+total resources: 14
+total selectable resources: 14
+total methods: 14
+
+
+ +::: + +## Resources +
+
+backup_plan
+backup_plans
+backup_selection
+backup_selections
+backup_vault
+backup_vaults
+framework +
+
+frameworks
+report_plan
+report_plans
+restore_testing_plan
+restore_testing_plans
+restore_testing_selection
+restore_testing_selections +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/backup/report_plan/index.md b/docs/awscc-docs/providers/awscc/backup/report_plan/index.md new file mode 100644 index 0000000000..93c97920ec --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/report_plan/index.md @@ -0,0 +1,79 @@ +--- +title: report_plan +hide_title: false +hide_table_of_contents: false +keywords: + - report_plan + - 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 +--- +Gets an individual report_plan resource + +## Overview + + + + + +
Namereport_plan
TypeResource
Descriptionreport_plan
Idawscc.backup.report_plan
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
report_plan_namestringThe 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 (_).
report_plan_arnstringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
report_plan_descriptionstringAn optional description of the report plan with a maximum of 1,024 characters.
report_plan_tagsarrayMetadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
report_delivery_channelobjectA 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.
report_settingobjectIdentifies the report template for the report. Reports are built using a report template.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the report_plan resource, the following permissions are required: + +### Read +
+backup:DescribeReportPlan,
+backup:ListTags
+ +### Update +
+backup:DescribeReportPlan,
+backup:UpdateReportPlan,
+backup:ListTags,
+backup:UntagResource,
+backup:TagResource
+ +### Delete +
+backup:DeleteReportPlan,
+backup:DescribeReportPlan
+ + +## Example +```sql +SELECT +region, +report_plan_name, +report_plan_arn, +report_plan_description, +report_plan_tags, +report_delivery_channel, +report_setting +FROM awscc.backup.report_plan +WHERE region = 'us-east-1' +AND data__Identifier = '<ReportPlanArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/report_plans/index.md b/docs/awscc-docs/providers/awscc/backup/report_plans/index.md new file mode 100644 index 0000000000..e18670f8c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/report_plans/index.md @@ -0,0 +1,62 @@ +--- +title: report_plans +hide_title: false +hide_table_of_contents: false +keywords: + - report_plans + - 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 +--- +Retrieves a list of report_plans in a region + +## Overview + + + + + +
Namereport_plans
TypeResource
Descriptionreport_plans
Idawscc.backup.report_plans
+ +## Fields + + + + + +
NameDatatypeDescription
report_plan_arnstringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the report_plans resource, the following permissions are required: + +### Create +
+backup:CreateReportPlan,
+backup:DescribeReportPlan,
+backup:ListTags,
+backup:TagResource,
+iam:CreateServiceLinkedRole
+ +### List +
+backup:ListReportPlans
+ + +## Example +```sql +SELECT +region, +report_plan_arn +FROM awscc.backup.report_plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/restore_testing_plan/index.md b/docs/awscc-docs/providers/awscc/backup/restore_testing_plan/index.md new file mode 100644 index 0000000000..efb515869c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/restore_testing_plan/index.md @@ -0,0 +1,81 @@ +--- +title: restore_testing_plan +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_plan + - 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 +--- +Gets an individual restore_testing_plan resource + +## Overview + + + + + +
Namerestore_testing_plan
TypeResource
Descriptionrestore_testing_plan
Idawscc.backup.restore_testing_plan
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
recovery_point_selectionobject
restore_testing_plan_arnstring
restore_testing_plan_namestring
schedule_expressionstring
schedule_expression_timezonestring
start_window_hoursinteger
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the restore_testing_plan resource, the following permissions are required: + +### Read +
+backup:GetRestoreTestingPlan,
+backup:ListTags
+ +### Update +
+backup:UpdateRestoreTestingPlan,
+backup:TagResource,
+backup:UntagResource,
+backup:GetRestoreTestingPlan,
+backup:ListTags
+ +### Delete +
+backup:DeleteRestoreTestingPlan,
+backup:GetRestoreTestingPlan
+ + +## Example +```sql +SELECT +region, +recovery_point_selection, +restore_testing_plan_arn, +restore_testing_plan_name, +schedule_expression, +schedule_expression_timezone, +start_window_hours, +tags +FROM awscc.backup.restore_testing_plan +WHERE region = 'us-east-1' +AND data__Identifier = '<RestoreTestingPlanName>' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/restore_testing_plans/index.md b/docs/awscc-docs/providers/awscc/backup/restore_testing_plans/index.md new file mode 100644 index 0000000000..ad817a2631 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/restore_testing_plans/index.md @@ -0,0 +1,61 @@ +--- +title: restore_testing_plans +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_plans + - 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 +--- +Retrieves a list of restore_testing_plans in a region + +## Overview + + + + + +
Namerestore_testing_plans
TypeResource
Descriptionrestore_testing_plans
Idawscc.backup.restore_testing_plans
+ +## Fields + + + + + +
NameDatatypeDescription
restore_testing_plan_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the restore_testing_plans resource, the following permissions are required: + +### Create +
+backup:CreateRestoreTestingPlan,
+backup:TagResource,
+backup:GetRestoreTestingPlan,
+backup:ListTags
+ +### List +
+backup:ListRestoreTestingPlans
+ + +## Example +```sql +SELECT +region, +restore_testing_plan_name +FROM awscc.backup.restore_testing_plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/restore_testing_selection/index.md b/docs/awscc-docs/providers/awscc/backup/restore_testing_selection/index.md new file mode 100644 index 0000000000..d013754285 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/restore_testing_selection/index.md @@ -0,0 +1,81 @@ +--- +title: restore_testing_selection +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_selection + - 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 +--- +Gets an individual restore_testing_selection resource + +## Overview + + + + + +
Namerestore_testing_selection
TypeResource
Descriptionrestore_testing_selection
Idawscc.backup.restore_testing_selection
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
iam_role_arnstring
protected_resource_arnsarray
protected_resource_conditionsobject
protected_resource_typestring
restore_metadata_overridesobject
restore_testing_plan_namestring
restore_testing_selection_namestring
validation_window_hoursinteger
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the restore_testing_selection resource, the following permissions are required: + +### Read +
+backup:GetRestoreTestingSelection
+ +### Update +
+backup:UpdateRestoreTestingSelection,
+backup:GetRestoreTestingSelection,
+iam:PassRole
+ +### Delete +
+backup:DeleteRestoreTestingSelection,
+backup:GetRestoreTestingSelection
+ + +## Example +```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, +validation_window_hours +FROM awscc.backup.restore_testing_selection +WHERE region = 'us-east-1' +AND data__Identifier = '<RestoreTestingPlanName>' +AND data__Identifier = '<RestoreTestingSelectionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/backup/restore_testing_selections/index.md b/docs/awscc-docs/providers/awscc/backup/restore_testing_selections/index.md new file mode 100644 index 0000000000..ab95279a86 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backup/restore_testing_selections/index.md @@ -0,0 +1,62 @@ +--- +title: restore_testing_selections +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_selections + - 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 +--- +Retrieves a list of restore_testing_selections in a region + +## Overview + + + + + +
Namerestore_testing_selections
TypeResource
Descriptionrestore_testing_selections
Idawscc.backup.restore_testing_selections
+ +## Fields + + + + + + +
NameDatatypeDescription
restore_testing_plan_namestring
restore_testing_selection_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the restore_testing_selections resource, the following permissions are required: + +### Create +
+backup:CreateRestoreTestingSelection,
+backup:GetRestoreTestingSelection,
+iam:PassRole
+ +### List +
+backup:ListRestoreTestingSelections
+ + +## Example +```sql +SELECT +region, +restore_testing_plan_name, +restore_testing_selection_name +FROM awscc.backup.restore_testing_selections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md b/docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md new file mode 100644 index 0000000000..aa759c0733 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md @@ -0,0 +1,84 @@ +--- +title: hypervisor +hide_title: false +hide_table_of_contents: false +keywords: + - hypervisor + - 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 +--- +Gets an individual hypervisor resource + +## Overview + + + + + +
Namehypervisor
TypeResource
Descriptionhypervisor
Idawscc.backupgateway.hypervisor
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
hoststring
hypervisor_arnstring
kms_key_arnstring
log_group_arnstring
namestring
passwordstring
tagsarray
usernamestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hypervisor resource, the following permissions are required: + +### Read +
+backup-gateway:GetHypervisor,
+backup-gateway:ListHypervisors
+ +### Update +
+backup-gateway:UpdateHypervisor,
+backup-gateway:GetHypervisor,
+backup-gateway:ListHypervisors,
+backup-gateway:ImportHypervisorConfiguration,
+backup-gateway:DeleteHypervisor
+ +### Delete +
+backup-gateway:DeleteHypervisor,
+backup-gateway:GetHypervisor,
+backup-gateway:ListHypervisors
+ + +## Example +```sql +SELECT +region, +host, +hypervisor_arn, +kms_key_arn, +log_group_arn, +name, +password, +tags, +username +FROM awscc.backupgateway.hypervisor +WHERE region = 'us-east-1' +AND data__Identifier = '<HypervisorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md b/docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md new file mode 100644 index 0000000000..57d836c887 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md @@ -0,0 +1,64 @@ +--- +title: hypervisors +hide_title: false +hide_table_of_contents: false +keywords: + - hypervisors + - 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 +--- +Retrieves a list of hypervisors in a region + +## Overview + + + + + +
Namehypervisors
TypeResource
Descriptionhypervisors
Idawscc.backupgateway.hypervisors
+ +## Fields + + + + + +
NameDatatypeDescription
hypervisor_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hypervisors resource, the following permissions are required: + +### Create +
+backup-gateway:ImportHypervisorConfiguration,
+backup-gateway:GetHypervisor,
+backup-gateway:ListHypervisors,
+backup-gateway:TagResource,
+kms:CreateGrant,
+kms:Encrypt,
+kms:Decrypt
+ +### List +
+backup-gateway:ListHypervisors
+ + +## Example +```sql +SELECT +region, +hypervisor_arn +FROM awscc.backupgateway.hypervisors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/backupgateway/index.md b/docs/awscc-docs/providers/awscc/backupgateway/index.md new file mode 100644 index 0000000000..352d351e9f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/backupgateway/index.md @@ -0,0 +1,39 @@ +--- +title: backupgateway +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The backupgateway service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+hypervisor +
+
+hypervisors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/batch/compute_environment/index.md b/docs/awscc-docs/providers/awscc/batch/compute_environment/index.md new file mode 100644 index 0000000000..afd038d3ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/batch/compute_environment/index.md @@ -0,0 +1,92 @@ +--- +title: compute_environment +hide_title: false +hide_table_of_contents: false +keywords: + - compute_environment + - 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 +--- +Gets an individual compute_environment resource + +## Overview + + + + + +
Namecompute_environment
TypeResource
Descriptioncompute_environment
Idawscc.batch.compute_environment
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
compute_environment_arnstring
compute_environment_namestring
compute_resourcesobject
replace_compute_environmentboolean
service_rolestring
statestring
tagsobjectA key-value pair to associate with a resource.
typestring
update_policyobject
unmanagedv_cpusinteger
eks_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the compute_environment resource, the following permissions are required: + +### Read +
+Batch:DescribeComputeEnvironments
+ +### Update +
+Batch:UpdateComputeEnvironment,
+Batch:DescribeComputeEnvironments,
+Batch:TagResource,
+Batch:UnTagResource,
+Iam:PassRole,
+Eks:DescribeCluster
+ +### Delete +
+Batch:DeleteComputeEnvironment,
+Batch:DescribeComputeEnvironments,
+Batch:UpdateComputeEnvironment,
+Iam:PassRole,
+Eks:DescribeCluster
+ + +## Example +```sql +SELECT +region, +compute_environment_arn, +compute_environment_name, +compute_resources, +replace_compute_environment, +service_role, +state, +tags, +type, +update_policy, +unmanagedv_cpus, +eks_configuration +FROM awscc.batch.compute_environment +WHERE region = 'us-east-1' +AND data__Identifier = '<ComputeEnvironmentArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/batch/compute_environments/index.md b/docs/awscc-docs/providers/awscc/batch/compute_environments/index.md new file mode 100644 index 0000000000..6c62c5df70 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/batch/compute_environments/index.md @@ -0,0 +1,63 @@ +--- +title: compute_environments +hide_title: false +hide_table_of_contents: false +keywords: + - compute_environments + - 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 +--- +Retrieves a list of compute_environments in a region + +## Overview + + + + + +
Namecompute_environments
TypeResource
Descriptioncompute_environments
Idawscc.batch.compute_environments
+ +## Fields + + + + + +
NameDatatypeDescription
compute_environment_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the compute_environments resource, the following permissions are required: + +### Create +
+Batch:CreateComputeEnvironment,
+Batch:TagResource,
+Batch:DescribeComputeEnvironments,
+iam:CreateServiceLinkedRole,
+Iam:PassRole,
+Eks:DescribeCluster
+ +### List +
+Batch:DescribeComputeEnvironments
+ + +## Example +```sql +SELECT +region, +compute_environment_arn +FROM awscc.batch.compute_environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/batch/index.md b/docs/awscc-docs/providers/awscc/batch/index.md new file mode 100644 index 0000000000..98b78d5a63 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/batch/index.md @@ -0,0 +1,43 @@ +--- +title: batch +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The batch service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+compute_environment
+compute_environments
+job_queue +
+
+job_queues
+scheduling_policies
+scheduling_policy +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/batch/job_queue/index.md b/docs/awscc-docs/providers/awscc/batch/job_queue/index.md new file mode 100644 index 0000000000..3901a740c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/batch/job_queue/index.md @@ -0,0 +1,80 @@ +--- +title: job_queue +hide_title: false +hide_table_of_contents: false +keywords: + - job_queue + - 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 +--- +Gets an individual job_queue resource + +## Overview + + + + + +
Namejob_queue
TypeResource
Descriptionjob_queue
Idawscc.batch.job_queue
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
job_queue_namestring
job_queue_arnstring
compute_environment_orderarray
priorityinteger
statestring
scheduling_policy_arnstring
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the job_queue resource, the following permissions are required: + +### Read +
+Batch:DescribeJobQueues
+ +### Update +
+Batch:DescribeJobQueues,
+Batch:UpdateJobQueue,
+Batch:TagResource,
+Batch:UnTagResource
+ +### Delete +
+Batch:UpdateJobQueue,
+Batch:DescribeJobQueues,
+Batch:DeleteJobQueue
+ + +## Example +```sql +SELECT +region, +job_queue_name, +job_queue_arn, +compute_environment_order, +priority, +state, +scheduling_policy_arn, +tags +FROM awscc.batch.job_queue +WHERE region = 'us-east-1' +AND data__Identifier = '<JobQueueArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/batch/job_queues/index.md b/docs/awscc-docs/providers/awscc/batch/job_queues/index.md new file mode 100644 index 0000000000..c970817c43 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/batch/job_queues/index.md @@ -0,0 +1,60 @@ +--- +title: job_queues +hide_title: false +hide_table_of_contents: false +keywords: + - job_queues + - 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 +--- +Retrieves a list of job_queues in a region + +## Overview + + + + + +
Namejob_queues
TypeResource
Descriptionjob_queues
Idawscc.batch.job_queues
+ +## Fields + + + + + +
NameDatatypeDescription
job_queue_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the job_queues resource, the following permissions are required: + +### Create +
+Batch:CreateJobQueue,
+Batch:TagResource,
+Batch:DescribeJobQueues
+ +### List +
+Batch:DescribeJobQueues
+ + +## Example +```sql +SELECT +region, +job_queue_arn +FROM awscc.batch.job_queues +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md b/docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md new file mode 100644 index 0000000000..1123c742c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md @@ -0,0 +1,60 @@ +--- +title: scheduling_policies +hide_title: false +hide_table_of_contents: false +keywords: + - scheduling_policies + - 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 +--- +Retrieves a list of scheduling_policies in a region + +## Overview + + + + + +
Namescheduling_policies
TypeResource
Descriptionscheduling_policies
Idawscc.batch.scheduling_policies
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduling_policies resource, the following permissions are required: + +### Create +
+Batch:CreateSchedulingPolicy,
+Batch:TagResource
+ +### List +
+Batch:ListSchedulingPolicies,
+Batch:DescribeSchedulingPolicies
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.batch.scheduling_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md b/docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md new file mode 100644 index 0000000000..5ffb917f1d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md @@ -0,0 +1,72 @@ +--- +title: scheduling_policy +hide_title: false +hide_table_of_contents: false +keywords: + - scheduling_policy + - 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 +--- +Gets an individual scheduling_policy resource + +## Overview + + + + + +
Namescheduling_policy
TypeResource
Descriptionscheduling_policy
Idawscc.batch.scheduling_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringName of Scheduling Policy.
arnstring
fairshare_policyobject
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduling_policy resource, the following permissions are required: + +### Read +
+Batch:DescribeSchedulingPolicies
+ +### Update +
+Batch:UpdateSchedulingPolicy,
+Batch:TagResource,
+Batch:UnTagResource
+ +### Delete +
+Batch:DescribeSchedulingPolicies,
+Batch:DeleteSchedulingPolicy
+ + +## Example +```sql +SELECT +region, +name, +arn, +fairshare_policy, +tags +FROM awscc.batch.scheduling_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md b/docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md new file mode 100644 index 0000000000..e7ef327ee3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md @@ -0,0 +1,98 @@ +--- +title: billing_group +hide_title: false +hide_table_of_contents: false +keywords: + - billing_group + - 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 +--- +Gets an individual billing_group resource + +## Overview + + + + + +
Namebilling_group
TypeResource
Descriptionbilling_group
Idawscc.billingconductor.billing_group
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringBilling Group ARN
namestring
descriptionstring
primary_account_idstringThis account will act as a virtual payer account of the billing group
computation_preferenceobject
account_groupingobject
sizeintegerNumber of accounts in the billing group
statusstring
status_reasonstring
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the billing_group resource, the following permissions are required: + +### Read +
+billingconductor:ListBillingGroups,
+billingconductor:ListAccountAssociations,
+organizations:ListAccounts,
+billingconductor:ListTagsForResource
+ +### Update +
+billingconductor:UpdateBillingGroup,
+billingconductor:ListAccountAssociations,
+organizations:ListAccounts,
+billingconductor:AssociateAccounts,
+billingconductor:DisassociateAccounts,
+billingconductor:ListBillingGroups,
+billingconductor:TagResource,
+billingconductor:UntagResource
+ +### Delete +
+billingconductor:DeleteBillingGroup,
+billingconductor:ListBillingGroups,
+billingconductor:UntagResource,
+billingconductor:UpdateBillingGroup
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +primary_account_id, +computation_preference, +account_grouping, +size, +status, +status_reason, +creation_time, +last_modified_time, +tags +FROM awscc.billingconductor.billing_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md b/docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md new file mode 100644 index 0000000000..9d94026cae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md @@ -0,0 +1,65 @@ +--- +title: billing_groups +hide_title: false +hide_table_of_contents: false +keywords: + - billing_groups + - 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 +--- +Retrieves a list of billing_groups in a region + +## Overview + + + + + +
Namebilling_groups
TypeResource
Descriptionbilling_groups
Idawscc.billingconductor.billing_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringBilling Group ARN
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the billing_groups resource, the following permissions are required: + +### Create +
+billingconductor:CreateBillingGroup,
+billingconductor:AssociateAccounts,
+billingconductor:ListBillingGroups,
+billingconductor:TagResource,
+billingconductor:ListTagsForResource
+ +### List +
+billingconductor:ListBillingGroups,
+billingconductor:ListAccountAssociations,
+organizations:ListAccounts,
+billingconductor:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.billingconductor.billing_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/custom_line_item/index.md b/docs/awscc-docs/providers/awscc/billingconductor/custom_line_item/index.md new file mode 100644 index 0000000000..2804c362c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/custom_line_item/index.md @@ -0,0 +1,100 @@ +--- +title: custom_line_item +hide_title: false +hide_table_of_contents: false +keywords: + - custom_line_item + - 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 +--- +Gets an individual custom_line_item resource + +## Overview + + + + + +
Namecustom_line_item
TypeResource
Descriptioncustom_line_item
Idawscc.billingconductor.custom_line_item
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
descriptionstring
custom_line_item_charge_detailsobject
billing_group_arnstringBilling Group ARN
billing_period_rangeobject
arnstringARN
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
association_sizeintegerNumber of source values associated to this custom line item
product_codestring
currency_codestring
account_idstringThe account which this custom line item will be charged to
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_line_item resource, the following permissions are required: + +### Read +
+billingconductor:ListCustomLineItems,
+billingconductor:ListCustomLineItemVersions,
+billingconductor:ListResourcesAssociatedToCustomLineItem,
+billingconductor:ListTagsForResource
+ +### Update +
+billingconductor:UpdateCustomLineItem,
+billingconductor:ListCustomLineItems,
+billingconductor:ListResourcesAssociatedToCustomLineItem,
+billingconductor:BatchAssociateResourcesToCustomLineItem,
+billingconductor:BatchDisassociateResourcesFromCustomLineItem,
+billingconductor:TagResource,
+billingconductor:UntagResource
+ +### Delete +
+billingconductor:DeleteCustomLineItem,
+billingconductor:ListCustomLineItems,
+billingconductor:BatchDisassociateResourcesFromCustomLineItem,
+billingconductor:ListResourcesAssociatedToCustomLineItem,
+billingconductor:UntagResource
+ + +## Example +```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, +tags +FROM awscc.billingconductor.custom_line_item +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/custom_line_items/index.md b/docs/awscc-docs/providers/awscc/billingconductor/custom_line_items/index.md new file mode 100644 index 0000000000..a45f6b6ca8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/custom_line_items/index.md @@ -0,0 +1,64 @@ +--- +title: custom_line_items +hide_title: false +hide_table_of_contents: false +keywords: + - custom_line_items + - 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 +--- +Retrieves a list of custom_line_items in a region + +## Overview + + + + + +
Namecustom_line_items
TypeResource
Descriptioncustom_line_items
Idawscc.billingconductor.custom_line_items
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringARN
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_line_items resource, the following permissions are required: + +### Create +
+billingconductor:CreateCustomLineItem,
+billingconductor:BatchAssociateResourcesToCustomLineItem,
+billingconductor:ListCustomLineItems,
+billingconductor:TagResource,
+billingconductor:ListTagsForResource
+ +### List +
+billingconductor:ListCustomLineItems,
+billingconductor:ListResourcesAssociatedToCustomLineItem,
+billingconductor:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.billingconductor.custom_line_items +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/index.md b/docs/awscc-docs/providers/awscc/billingconductor/index.md new file mode 100644 index 0000000000..9083974b9a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/index.md @@ -0,0 +1,45 @@ +--- +title: billingconductor +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The billingconductor service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+billing_group
+billing_groups
+custom_line_item
+custom_line_items +
+
+pricing_plan
+pricing_plans
+pricing_rule
+pricing_rules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/billingconductor/pricing_plan/index.md b/docs/awscc-docs/providers/awscc/billingconductor/pricing_plan/index.md new file mode 100644 index 0000000000..fa3df0acd6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/pricing_plan/index.md @@ -0,0 +1,87 @@ +--- +title: pricing_plan +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_plan + - 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 +--- +Gets an individual pricing_plan resource + +## Overview + + + + + +
Namepricing_plan
TypeResource
Descriptionpricing_plan
Idawscc.billingconductor.pricing_plan
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstringPricing Plan ARN
namestring
pricing_rule_arnsarray
sizeintegerNumber of associated pricing rules
descriptionstring
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pricing_plan resource, the following permissions are required: + +### Read +
+billingconductor:ListPricingPlans,
+billingconductor:ListPricingRulesAssociatedToPricingPlan,
+billingconductor:ListTagsForResource
+ +### Update +
+billingconductor:ListPricingPlans,
+billingconductor:UpdatePricingPlan,
+billingconductor:ListPricingRulesAssociatedToPricingPlan,
+billingconductor:AssociatePricingRules,
+billingconductor:DisassociatePricingRules,
+billingconductor:TagResource,
+billingconductor:UntagResource
+ +### Delete +
+billingconductor:ListPricingPlans,
+billingconductor:DeletePricingPlan,
+billingconductor:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +name, +pricing_rule_arns, +size, +description, +creation_time, +last_modified_time, +tags +FROM awscc.billingconductor.pricing_plan +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md b/docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md new file mode 100644 index 0000000000..e5f248210f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md @@ -0,0 +1,64 @@ +--- +title: pricing_plans +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_plans + - 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 +--- +Retrieves a list of pricing_plans in a region + +## Overview + + + + + +
Namepricing_plans
TypeResource
Descriptionpricing_plans
Idawscc.billingconductor.pricing_plans
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringPricing Plan ARN
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pricing_plans resource, the following permissions are required: + +### Create +
+billingconductor:CreatePricingPlan,
+billingconductor:AssociatePricingRules,
+billingconductor:ListPricingPlans,
+billingconductor:TagResource,
+billingconductor:ListTagsForResource
+ +### List +
+billingconductor:ListPricingPlans,
+billingconductor:ListPricingRulesAssociatedToPricingPlan,
+billingconductor:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.billingconductor.pricing_plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md b/docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md new file mode 100644 index 0000000000..c5fe641222 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md @@ -0,0 +1,97 @@ +--- +title: pricing_rule +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_rule + - 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 +--- +Gets an individual pricing_rule resource + +## Overview + + + + + +
Namepricing_rule
TypeResource
Descriptionpricing_rule
Idawscc.billingconductor.pricing_rule
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringPricing rule ARN
namestringPricing rule name
descriptionstringPricing rule description
scopestringA term used to categorize the granularity of a Pricing Rule.
typestringOne of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.
modifier_percentagenumberPricing rule modifier percentage
servicestringThe service which a pricing rule is applied on
billing_entitystringThe 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.
tieringobjectThe set of tiering configurations for the pricing rule.
usage_typestringThe UsageType which a SKU pricing rule is modifying
operationstringThe Operation which a SKU pricing rule is modifying
associated_pricing_plan_countintegerThe number of pricing plans associated with pricing rule
creation_timeintegerCreation timestamp in UNIX epoch time format
last_modified_timeintegerLatest modified timestamp in UNIX epoch time format
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pricing_rule resource, the following permissions are required: + +### Read +
+billingconductor:ListPricingRules,
+billingconductor:ListTagsForResource
+ +### Update +
+billingconductor:UpdatePricingRule,
+billingconductor:ListPricingRules,
+billingconductor:TagResource,
+billingconductor:UntagResource
+ +### Delete +
+billingconductor:DeletePricingRule,
+billingconductor:ListPricingRules,
+billingconductor:UntagResource
+ + +## Example +```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, +tags +FROM awscc.billingconductor.pricing_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md b/docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md new file mode 100644 index 0000000000..1862ce920d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md @@ -0,0 +1,62 @@ +--- +title: pricing_rules +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_rules + - 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 +--- +Retrieves a list of pricing_rules in a region + +## Overview + + + + + +
Namepricing_rules
TypeResource
Descriptionpricing_rules
Idawscc.billingconductor.pricing_rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringPricing rule ARN
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pricing_rules resource, the following permissions are required: + +### Create +
+billingconductor:CreatePricingRule,
+billingconductor:ListPricingRules,
+billingconductor:TagResource,
+billingconductor:ListTagsForResource
+ +### List +
+billingconductor:ListPricingRules,
+billingconductor:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.billingconductor.pricing_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md b/docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md new file mode 100644 index 0000000000..4c389d95f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md @@ -0,0 +1,81 @@ +--- +title: budgets_action +hide_title: false +hide_table_of_contents: false +keywords: + - budgets_action + - 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 +--- +Gets an individual budgets_action resource + +## Overview + + + + + +
Namebudgets_action
TypeResource
Descriptionbudgets_action
Idawscc.budgets.budgets_action
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
action_idstring
budget_namestring
notification_typestring
action_typestring
action_thresholdobject
execution_role_arnstring
approval_modelstring
subscribersarray
definitionobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the budgets_action resource, the following permissions are required: + +### Read +
+budgets:DescribeBudgetAction
+ +### Update +
+budgets:UpdateBudgetAction,
+iam:PassRole
+ +### Delete +
+budgets:DeleteBudgetAction
+ + +## Example +```sql +SELECT +region, +action_id, +budget_name, +notification_type, +action_type, +action_threshold, +execution_role_arn, +approval_model, +subscribers, +definition +FROM awscc.budgets.budgets_action +WHERE region = 'us-east-1' +AND data__Identifier = '<ActionId>' +AND data__Identifier = '<BudgetName>' +``` diff --git a/docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md b/docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md new file mode 100644 index 0000000000..82d9c20e21 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md @@ -0,0 +1,62 @@ +--- +title: budgets_actions +hide_title: false +hide_table_of_contents: false +keywords: + - budgets_actions + - 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 +--- +Retrieves a list of budgets_actions in a region + +## Overview + + + + + +
Namebudgets_actions
TypeResource
Descriptionbudgets_actions
Idawscc.budgets.budgets_actions
+ +## Fields + + + + + + +
NameDatatypeDescription
action_idstring
budget_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the budgets_actions resource, the following permissions are required: + +### Create +
+budgets:CreateBudgetAction,
+iam:PassRole
+ +### List +
+budgets:DescribeBudgetActionsForAccount,
+budgets:DescribeBudgetActionsForBudget
+ + +## Example +```sql +SELECT +region, +action_id, +budget_name +FROM awscc.budgets.budgets_actions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/budgets/index.md b/docs/awscc-docs/providers/awscc/budgets/index.md new file mode 100644 index 0000000000..39b930d222 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/budgets/index.md @@ -0,0 +1,39 @@ +--- +title: budgets +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The budgets service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+budgets_action +
+
+budgets_actions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cassandra/index.md b/docs/awscc-docs/providers/awscc/cassandra/index.md new file mode 100644 index 0000000000..543e1443bc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cassandra/index.md @@ -0,0 +1,41 @@ +--- +title: cassandra +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cassandra service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+keyspace
+keyspaces +
+
+table
+tables +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cassandra/keyspace/index.md b/docs/awscc-docs/providers/awscc/cassandra/keyspace/index.md new file mode 100644 index 0000000000..89a2e73140 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cassandra/keyspace/index.md @@ -0,0 +1,78 @@ +--- +title: keyspace +hide_title: false +hide_table_of_contents: false +keywords: + - keyspace + - 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 +--- +Gets an individual keyspace resource + +## Overview + + + + + +
Namekeyspace
TypeResource
Descriptionkeyspace
Idawscc.cassandra.keyspace
+ +## Fields + + + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
tagsarray
replication_specificationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the keyspace resource, the following permissions are required: + +### Read +
+cassandra:Select,
+cassandra:SelectMultiRegionResource
+ +### Update +
+cassandra:Alter,
+cassandra:AlterMultiRegionResource,
+cassandra:Select,
+cassandra:SelectMultiRegionResource,
+cassandra:TagResource,
+cassandra:TagMultiRegionResource,
+cassandra:UntagResource,
+cassandra:UntagMultiRegionResource
+ +### Delete +
+cassandra:Drop,
+cassandra:DropMultiRegionResource,
+cassandra:Select,
+cassandra:SelectMultiRegionResource
+ + +## Example +```sql +SELECT +region, +keyspace_name, +tags, +replication_specification +FROM awscc.cassandra.keyspace +WHERE region = 'us-east-1' +AND data__Identifier = '<KeyspaceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md b/docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md new file mode 100644 index 0000000000..401ea8a39a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md @@ -0,0 +1,65 @@ +--- +title: keyspaces +hide_title: false +hide_table_of_contents: false +keywords: + - keyspaces + - 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 +--- +Retrieves a list of keyspaces in a region + +## Overview + + + + + +
Namekeyspaces
TypeResource
Descriptionkeyspaces
Idawscc.cassandra.keyspaces
+ +## Fields + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the keyspaces resource, the following permissions are required: + +### Create +
+cassandra:Create,
+cassandra:CreateMultiRegionResource,
+cassandra:Select,
+cassandra:SelectMultiRegionResource,
+cassandra:TagResource,
+cassandra:TagMultiRegionResource,
+iam:CreateServiceLinkedRole
+ +### List +
+cassandra:Select,
+cassandra:SelectMultiRegionResource
+ + +## Example +```sql +SELECT +region, +keyspace_name +FROM awscc.cassandra.keyspaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cassandra/table/index.md b/docs/awscc-docs/providers/awscc/cassandra/table/index.md new file mode 100644 index 0000000000..041ce9ccf9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cassandra/table/index.md @@ -0,0 +1,130 @@ +--- +title: table +hide_title: false +hide_table_of_contents: false +keywords: + - table + - 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 +--- +Gets an individual table resource + +## Overview + + + + + +
Nametable
TypeResource
Descriptiontable
Idawscc.cassandra.table
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
table_namestringName for Cassandra table
regular_columnsarrayNon-key columns of the table
partition_key_columnsarrayPartition key columns of the table
clustering_key_columnsarrayClustering key columns of the table
billing_modeobject
point_in_time_recovery_enabledbooleanIndicates whether point in time recovery is enabled (true) or disabled (false) on the table
client_side_timestamps_enabledbooleanIndicates 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.
tagsarrayAn array of key-value pairs to apply to this resource
default_time_to_liveintegerDefault 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.
encryption_specificationobject
auto_scaling_specificationsobject
replica_specificationsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the table resource, the following permissions are required: + +### Read +
+cassandra:Select,
+cassandra:SelectMultiRegionResource,
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:RegisterScalableTarget,
+application-autoscaling:PutScalingPolicy,
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms,
+cloudwatch:GetMetricData,
+cloudwatch:PutMetricAlarm
+ +### Update +
+cassandra:Alter,
+cassandra:AlterMultiRegionResource,
+cassandra:Select,
+cassandra:SelectMultiRegionResource,
+cassandra:TagResource,
+cassandra:TagMultiRegionResource,
+cassandra:UntagResource,
+cassandra:UntagMultiRegionResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:Encrypt,
+kms:Decrypt,
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:RegisterScalableTarget,
+application-autoscaling:PutScalingPolicy,
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms,
+cloudwatch:GetMetricData,
+cloudwatch:PutMetricAlarm
+ +### Delete +
+cassandra:Drop,
+cassandra:DropMultiRegionResource,
+cassandra:Select,
+cassandra:SelectMultiRegionResource,
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:RegisterScalableTarget,
+application-autoscaling:PutScalingPolicy,
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms,
+cloudwatch:GetMetricData,
+cloudwatch:PutMetricAlarm
+ + +## Example +```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, +tags, +default_time_to_live, +encryption_specification, +auto_scaling_specifications, +replica_specifications +FROM awscc.cassandra.table +WHERE region = 'us-east-1' +AND data__Identifier = '<KeyspaceName>' +AND data__Identifier = '<TableName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cassandra/tables/index.md b/docs/awscc-docs/providers/awscc/cassandra/tables/index.md new file mode 100644 index 0000000000..93b1181b77 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cassandra/tables/index.md @@ -0,0 +1,88 @@ +--- +title: tables +hide_title: false +hide_table_of_contents: false +keywords: + - tables + - 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 +--- +Retrieves a list of tables in a region + +## Overview + + + + + +
Nametables
TypeResource
Descriptiontables
Idawscc.cassandra.tables
+ +## Fields + + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
table_namestringName for Cassandra table
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tables resource, the following permissions are required: + +### Create +
+cassandra:Create,
+cassandra:CreateMultiRegionResource,
+cassandra:Select,
+cassandra:SelectMultiRegionResource,
+cassandra:TagResource,
+cassandra:TagMultiRegionResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:Encrypt,
+kms:Decrypt,
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:RegisterScalableTarget,
+application-autoscaling:PutScalingPolicy,
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms,
+cloudwatch:GetMetricData,
+cloudwatch:PutMetricAlarm
+ +### List +
+cassandra:Select,
+cassandra:SelectMultiRegionResource,
+application-autoscaling:DescribeScalableTargets,
+application-autoscaling:DescribeScalingPolicies,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:RegisterScalableTarget,
+application-autoscaling:PutScalingPolicy,
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms,
+cloudwatch:GetMetricData,
+cloudwatch:PutMetricAlarm
+ + +## Example +```sql +SELECT +region, +keyspace_name, +table_name +FROM awscc.cassandra.tables +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md new file mode 100644 index 0000000000..ebda125635 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md @@ -0,0 +1,81 @@ +--- +title: anomaly_monitor +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_monitor + - 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 +--- +Gets an individual anomaly_monitor resource + +## Overview + + + + + +
Nameanomaly_monitor
TypeResource
Descriptionanomaly_monitor
Idawscc.ce.anomaly_monitor
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
monitor_arnstring
monitor_typestring
monitor_namestringThe name of the monitor.
creation_datestringThe date when the monitor was created.
last_evaluated_datestringThe date when the monitor last evaluated for anomalies.
last_updated_datestringThe date when the monitor was last updated.
monitor_dimensionstringThe dimensions to evaluate
monitor_specificationstring
dimensional_value_countintegerThe value for evaluated dimensions.
resource_tagsarrayTags to assign to monitor.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the anomaly_monitor resource, the following permissions are required: + +### Read +
+ce:GetAnomalyMonitors
+ +### Update +
+ce:UpdateAnomalyMonitor
+ +### Delete +
+ce:DeleteAnomalyMonitor
+ + +## Example +```sql +SELECT +region, +monitor_arn, +monitor_type, +monitor_name, +creation_date, +last_evaluated_date, +last_updated_date, +monitor_dimension, +monitor_specification, +dimensional_value_count, +resource_tags +FROM awscc.ce.anomaly_monitor +WHERE region = 'us-east-1' +AND data__Identifier = '<MonitorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md new file mode 100644 index 0000000000..a59f78d2db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md @@ -0,0 +1,59 @@ +--- +title: anomaly_monitors +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_monitors + - 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 +--- +Retrieves a list of anomaly_monitors in a region + +## Overview + + + + + +
Nameanomaly_monitors
TypeResource
Descriptionanomaly_monitors
Idawscc.ce.anomaly_monitors
+ +## Fields + + + + + +
NameDatatypeDescription
monitor_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the anomaly_monitors resource, the following permissions are required: + +### Create +
+ce:CreateAnomalyMonitor,
+ce:TagResource
+ +### List +
+ce:GetAnomalyMonitors
+ + +## Example +```sql +SELECT +region, +monitor_arn +FROM awscc.ce.anomaly_monitors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md new file mode 100644 index 0000000000..a7f3713882 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md @@ -0,0 +1,79 @@ +--- +title: anomaly_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_subscription + - 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 +--- +Gets an individual anomaly_subscription resource + +## Overview + + + + + +
Nameanomaly_subscription
TypeResource
Descriptionanomaly_subscription
Idawscc.ce.anomaly_subscription
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
subscription_arnstring
subscription_namestringThe name of the subscription.
account_idstringThe accountId
monitor_arn_listarrayA list of cost anomaly monitors.
subscribersarrayA list of subscriber
thresholdnumberThe dollar value that triggers a notification if the threshold is exceeded.
threshold_expressionstringAn Expression object in JSON String format used to specify the anomalies that you want to generate alerts for.
frequencystringThe frequency at which anomaly reports are sent over email.
resource_tagsarrayTags to assign to subscription.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the anomaly_subscription resource, the following permissions are required: + +### Read +
+ce:GetAnomalySubscriptions
+ +### Update +
+ce:UpdateAnomalySubscription
+ +### Delete +
+ce:DeleteAnomalySubscription
+ + +## Example +```sql +SELECT +region, +subscription_arn, +subscription_name, +account_id, +monitor_arn_list, +subscribers, +threshold, +threshold_expression, +frequency, +resource_tags +FROM awscc.ce.anomaly_subscription +WHERE region = 'us-east-1' +AND data__Identifier = '<SubscriptionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md new file mode 100644 index 0000000000..a08841fa2b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md @@ -0,0 +1,59 @@ +--- +title: anomaly_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_subscriptions + - 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 +--- +Retrieves a list of anomaly_subscriptions in a region + +## Overview + + + + + +
Nameanomaly_subscriptions
TypeResource
Descriptionanomaly_subscriptions
Idawscc.ce.anomaly_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
subscription_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the anomaly_subscriptions resource, the following permissions are required: + +### Create +
+ce:CreateAnomalySubscription,
+ce:TagResource
+ +### List +
+ce:GetAnomalySubscriptions
+ + +## Example +```sql +SELECT +region, +subscription_arn +FROM awscc.ce.anomaly_subscriptions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ce/cost_categories/index.md b/docs/awscc-docs/providers/awscc/ce/cost_categories/index.md new file mode 100644 index 0000000000..f349af5343 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ce/cost_categories/index.md @@ -0,0 +1,58 @@ +--- +title: cost_categories +hide_title: false +hide_table_of_contents: false +keywords: + - cost_categories + - 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 +--- +Retrieves a list of cost_categories in a region + +## Overview + + + + + +
Namecost_categories
TypeResource
Descriptioncost_categories
Idawscc.ce.cost_categories
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringCost category ARN
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cost_categories resource, the following permissions are required: + +### Create +
+ce:CreateCostCategoryDefinition
+ +### List +
+ce:ListCostCategoryDefinitions
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ce.cost_categories +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ce/cost_category/index.md b/docs/awscc-docs/providers/awscc/ce/cost_category/index.md new file mode 100644 index 0000000000..5bdbe656ad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ce/cost_category/index.md @@ -0,0 +1,75 @@ +--- +title: cost_category +hide_title: false +hide_table_of_contents: false +keywords: + - cost_category + - 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 +--- +Gets an individual cost_category resource + +## Overview + + + + + +
Namecost_category
TypeResource
Descriptioncost_category
Idawscc.ce.cost_category
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstringCost category ARN
effective_startstring
namestring
rule_versionstring
rulesstringJSON array format of Expression in Billing and Cost Management API
split_charge_rulesstringJson array format of CostCategorySplitChargeRule in Billing and Cost Management API
default_valuestringThe default value for the cost category
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cost_category resource, the following permissions are required: + +### Read +
+ce:DescribeCostCategoryDefinition
+ +### Update +
+ce:UpdateCostCategoryDefinition
+ +### Delete +
+ce:DeleteCostCategoryDefinition
+ + +## Example +```sql +SELECT +region, +arn, +effective_start, +name, +rule_version, +rules, +split_charge_rules, +default_value +FROM awscc.ce.cost_category +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ce/index.md b/docs/awscc-docs/providers/awscc/ce/index.md new file mode 100644 index 0000000000..a8159fc1d3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ce/index.md @@ -0,0 +1,43 @@ +--- +title: ce +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ce service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+anomaly_monitor
+anomaly_monitors
+anomaly_subscription +
+
+anomaly_subscriptions
+cost_categories
+cost_category +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/certificatemanager/account/index.md b/docs/awscc-docs/providers/awscc/certificatemanager/account/index.md new file mode 100644 index 0000000000..942d31c693 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/certificatemanager/account/index.md @@ -0,0 +1,67 @@ +--- +title: account +hide_title: false +hide_table_of_contents: false +keywords: + - account + - certificatemanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual account resource + +## Overview + + + + + +
Nameaccount
TypeResource
Descriptionaccount
Idawscc.certificatemanager.account
+ +## Fields + + + + + + +
NameDatatypeDescription
expiry_events_configurationobject
account_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account resource, the following permissions are required: + +### Read +
+acm:GetAccountConfiguration
+ +### Update +
+acm:GetAccountConfiguration,
+acm:PutAccountConfiguration
+ +### Delete +
+acm:GetAccountConfiguration,
+acm:PutAccountConfiguration
+ + +## Example +```sql +SELECT +region, +expiry_events_configuration, +account_id +FROM awscc.certificatemanager.account +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/certificatemanager/accounts/index.md b/docs/awscc-docs/providers/awscc/certificatemanager/accounts/index.md new file mode 100644 index 0000000000..e89df899b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/certificatemanager/accounts/index.md @@ -0,0 +1,55 @@ +--- +title: accounts +hide_title: false +hide_table_of_contents: false +keywords: + - accounts + - certificatemanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of accounts in a region + +## Overview + + + + + +
Nameaccounts
TypeResource
Descriptionaccounts
Idawscc.certificatemanager.accounts
+ +## Fields + + + + + +
NameDatatypeDescription
account_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Create +
+acm:GetAccountConfiguration,
+acm:PutAccountConfiguration
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.certificatemanager.accounts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/certificatemanager/index.md b/docs/awscc-docs/providers/awscc/certificatemanager/index.md new file mode 100644 index 0000000000..eca5d387d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/certificatemanager/index.md @@ -0,0 +1,39 @@ +--- +title: certificatemanager +hide_title: false +hide_table_of_contents: false +keywords: + - certificatemanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The certificatemanager service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+account +
+
+accounts +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/chatbot/index.md b/docs/awscc-docs/providers/awscc/chatbot/index.md new file mode 100644 index 0000000000..16f32c281e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/chatbot/index.md @@ -0,0 +1,41 @@ +--- +title: chatbot +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The chatbot service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+microsoft_teams_channel_configuration
+microsoft_teams_channel_configurations +
+
+slack_channel_configuration
+slack_channel_configurations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configuration/index.md b/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configuration/index.md new file mode 100644 index 0000000000..6f344f7e3a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configuration/index.md @@ -0,0 +1,83 @@ +--- +title: microsoft_teams_channel_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - microsoft_teams_channel_configuration + - 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 +--- +Gets an individual microsoft_teams_channel_configuration resource + +## Overview + + + + + +
Namemicrosoft_teams_channel_configuration
TypeResource
Descriptionmicrosoft_teams_channel_configuration
Idawscc.chatbot.microsoft_teams_channel_configuration
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
team_idstringThe id of the Microsoft Teams team
teams_channel_idstringThe id of the Microsoft Teams channel
teams_tenant_idstringThe id of the Microsoft Teams tenant
configuration_namestringThe name of the configuration
iam_role_arnstringThe ARN of the IAM role that defines the permissions for AWS Chatbot
sns_topic_arnsarrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
logging_levelstringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
arnstringAmazon Resource Name (ARN) of the configuration
guardrail_policiesarrayThe 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.
user_role_requiredbooleanEnables use of a user role requirement in your chat configuration
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the microsoft_teams_channel_configuration resource, the following permissions are required: + +### Read +
+chatbot:GetMicrosoftTeamsChannelConfiguration
+ +### Update +
+chatbot:UpdateMicrosoftTeamsChannelConfiguration,
+iam:PassRole
+ +### Delete +
+chatbot:GetMicrosoftTeamsChannelConfiguration,
+chatbot:DeleteMicrosoftTeamsChannelConfiguration
+ + +## Example +```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 +FROM awscc.chatbot.microsoft_teams_channel_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configurations/index.md b/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configurations/index.md new file mode 100644 index 0000000000..09a44ad357 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: microsoft_teams_channel_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - microsoft_teams_channel_configurations + - 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 +--- +Retrieves a list of microsoft_teams_channel_configurations in a region + +## Overview + + + + + +
Namemicrosoft_teams_channel_configurations
TypeResource
Descriptionmicrosoft_teams_channel_configurations
Idawscc.chatbot.microsoft_teams_channel_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the configuration
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the microsoft_teams_channel_configurations resource, the following permissions are required: + +### Create +
+chatbot:CreateMicrosoftTeamsChannelConfiguration,
+iam:PassRole,
+iam:CreateServiceLinkedRole
+ +### List +
+chatbot:ListMicrosoftTeamsChannelConfigurations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.chatbot.microsoft_teams_channel_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configuration/index.md b/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configuration/index.md new file mode 100644 index 0000000000..6e8ab50b55 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configuration/index.md @@ -0,0 +1,80 @@ +--- +title: slack_channel_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configuration + - 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 +--- +Gets an individual slack_channel_configuration resource + +## Overview + + + + + +
Nameslack_channel_configuration
TypeResource
Descriptionslack_channel_configuration
Idawscc.chatbot.slack_channel_configuration
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
slack_workspace_idstringThe id of the Slack workspace
slack_channel_idstringThe id of the Slack channel
configuration_namestringThe name of the configuration
iam_role_arnstringThe ARN of the IAM role that defines the permissions for AWS Chatbot
sns_topic_arnsarrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
logging_levelstringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
arnstringAmazon Resource Name (ARN) of the configuration
guardrail_policiesarrayThe 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.
user_role_requiredbooleanEnables use of a user role requirement in your chat configuration
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the slack_channel_configuration resource, the following permissions are required: + +### Read +
+chatbot:DescribeSlackChannelConfigurations
+ +### Update +
+chatbot:UpdateSlackChannelConfiguration,
+iam:PassRole
+ +### Delete +
+chatbot:DeleteSlackChannelConfiguration
+ + +## Example +```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 +FROM awscc.chatbot.slack_channel_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configurations/index.md b/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configurations/index.md new file mode 100644 index 0000000000..396cb7a950 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: slack_channel_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configurations + - 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 +--- +Retrieves a list of slack_channel_configurations in a region + +## Overview + + + + + +
Nameslack_channel_configurations
TypeResource
Descriptionslack_channel_configurations
Idawscc.chatbot.slack_channel_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the configuration
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the slack_channel_configurations resource, the following permissions are required: + +### Create +
+chatbot:CreateSlackChannelConfiguration,
+iam:PassRole,
+iam:CreateServiceLinkedRole
+ +### List +
+chatbot:DescribeSlackChannelConfigurations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.chatbot.slack_channel_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md new file mode 100644 index 0000000000..d84bc6b1e1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md @@ -0,0 +1,97 @@ +--- +title: analysis_template +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_template + - 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 +--- +Gets an individual analysis_template resource + +## Overview + + + + + +
Nameanalysis_template
TypeResource
Descriptionanalysis_template
Idawscc.cleanrooms.analysis_template
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
collaboration_arnstring
collaboration_identifierstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
analysis_parametersarrayThe member who can query can provide this placeholder for a literal data value in an analysis template
analysis_template_identifierstring
descriptionstring
membership_arnstring
membership_identifierstring
namestring
schemaobject
sourceobject
formatstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the analysis_template resource, the following permissions are required: + +### Read +
+cleanrooms:GetAnalysisTemplate,
+cleanrooms:ListTagsForResource
+ +### Update +
+cleanrooms:UpdateAnalysisTemplate,
+cleanrooms:GetAnalysisTemplate,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:UntagResource
+ +### Delete +
+cleanrooms:DeleteAnalysisTemplate,
+cleanrooms:GetAnalysisTemplate,
+cleanrooms:ListAnalysisTemplates,
+cleanrooms:ListTagsForResource,
+cleanrooms:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +tags, +analysis_parameters, +analysis_template_identifier, +description, +membership_arn, +membership_identifier, +name, +schema, +source, +format +FROM awscc.cleanrooms.analysis_template +WHERE region = 'us-east-1' +AND data__Identifier = '<AnalysisTemplateIdentifier>' +AND data__Identifier = '<MembershipIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md new file mode 100644 index 0000000000..27b40c8fb7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md @@ -0,0 +1,64 @@ +--- +title: analysis_templates +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_templates + - 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 +--- +Retrieves a list of analysis_templates in a region + +## Overview + + + + + +
Nameanalysis_templates
TypeResource
Descriptionanalysis_templates
Idawscc.cleanrooms.analysis_templates
+ +## Fields + + + + + + +
NameDatatypeDescription
analysis_template_identifierstring
membership_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the analysis_templates resource, the following permissions are required: + +### Create +
+cleanrooms:CreateAnalysisTemplate,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:GetAnalysisTemplate,
+cleanrooms:ListAnalysisTemplates
+ +### List +
+cleanrooms:ListAnalysisTemplates
+ + +## Example +```sql +SELECT +region, +analysis_template_identifier, +membership_identifier +FROM awscc.cleanrooms.analysis_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md new file mode 100644 index 0000000000..eff4721756 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md @@ -0,0 +1,95 @@ +--- +title: collaboration +hide_title: false +hide_table_of_contents: false +keywords: + - collaboration + - 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 +--- +Gets an individual collaboration resource + +## Overview + + + + + +
Namecollaboration
TypeResource
Descriptioncollaboration
Idawscc.cleanrooms.collaboration
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
collaboration_identifierstring
creator_display_namestring
creator_member_abilitiesarray
data_encryption_metadataobject
descriptionstring
membersarray
namestring
query_log_statusstring
creator_payment_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the collaboration resource, the following permissions are required: + +### Read +
+cleanrooms:GetCollaboration,
+cleanrooms:ListMembers,
+cleanrooms:ListTagsForResource
+ +### Update +
+cleanrooms:UpdateCollaboration,
+cleanrooms:GetCollaboration,
+cleanrooms:ListMembers,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:UntagResource
+ +### Delete +
+cleanrooms:DeleteCollaboration,
+cleanrooms:GetCollaboration,
+cleanrooms:ListTagsForResource,
+cleanrooms:UntagResource,
+cleanrooms:ListMembers,
+cleanrooms:ListCollaborations
+ + +## Example +```sql +SELECT +region, +arn, +tags, +collaboration_identifier, +creator_display_name, +creator_member_abilities, +data_encryption_metadata, +description, +members, +name, +query_log_status, +creator_payment_configuration +FROM awscc.cleanrooms.collaboration +WHERE region = 'us-east-1' +AND data__Identifier = '<CollaborationIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md new file mode 100644 index 0000000000..df02d640a5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md @@ -0,0 +1,64 @@ +--- +title: collaborations +hide_title: false +hide_table_of_contents: false +keywords: + - collaborations + - 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 +--- +Retrieves a list of collaborations in a region + +## Overview + + + + + +
Namecollaborations
TypeResource
Descriptioncollaborations
Idawscc.cleanrooms.collaborations
+ +## Fields + + + + + +
NameDatatypeDescription
collaboration_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the collaborations resource, the following permissions are required: + +### Create +
+cleanrooms:CreateCollaboration,
+cleanrooms:GetCollaboration,
+cleanrooms:ListMembers,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:GetCollaboration,
+cleanrooms:ListCollaborations
+ +### List +
+cleanrooms:ListCollaborations
+ + +## Example +```sql +SELECT +region, +collaboration_identifier +FROM awscc.cleanrooms.collaborations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md new file mode 100644 index 0000000000..7f8138848c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md @@ -0,0 +1,111 @@ +--- +title: configured_table +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table + - 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 +--- +Gets an individual configured_table resource + +## Overview + + + + + +
Nameconfigured_table
TypeResource
Descriptionconfigured_table
Idawscc.cleanrooms.configured_table
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
allowed_columnsarray
analysis_methodstring
configured_table_identifierstring
descriptionstring
namestring
analysis_rulesarray
table_referenceobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configured_table resource, the following permissions are required: + +### Read +
+cleanrooms:GetConfiguredTable,
+cleanrooms:GetConfiguredTableAnalysisRule,
+cleanrooms:ListTagsForResource
+ +### Update +
+cleanrooms:UpdateConfiguredTable,
+cleanrooms:GetConfiguredTable,
+cleanrooms:CreateConfiguredTableAnalysisRule,
+cleanrooms:UpdateConfiguredTableAnalysisRule,
+cleanrooms:GetConfiguredTableAnalysisRule,
+cleanrooms:DeleteConfiguredTableAnalysisRule,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:UntagResource,
+glue:GetDatabase,
+glue:GetDatabases,
+glue:GetTable,
+glue:GetTables,
+glue:GetPartition,
+glue:GetPartitions,
+glue:BatchGetPartition,
+glue:GetSchemaVersion
+ +### Delete +
+cleanrooms:DeleteConfiguredTable,
+cleanrooms:GetConfiguredTable,
+cleanrooms:ListConfiguredTables,
+cleanrooms:GetConfiguredTableAnalysisRule,
+cleanrooms:DeleteConfiguredTableAnalysisRule,
+cleanrooms:ListTagsForResource,
+cleanrooms:UntagResource,
+glue:GetDatabase,
+glue:GetDatabases,
+glue:GetTable,
+glue:GetTables,
+glue:GetPartition,
+glue:GetPartitions,
+glue:BatchGetPartition,
+glue:GetSchemaVersion
+ + +## Example +```sql +SELECT +region, +arn, +tags, +allowed_columns, +analysis_method, +configured_table_identifier, +description, +name, +analysis_rules, +table_reference +FROM awscc.cleanrooms.configured_table +WHERE region = 'us-east-1' +AND data__Identifier = '<ConfiguredTableIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_association/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_association/index.md new file mode 100644 index 0000000000..ff797b8ea6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_association/index.md @@ -0,0 +1,88 @@ +--- +title: configured_table_association +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_association + - 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 +--- +Gets an individual configured_table_association resource + +## Overview + + + + + +
Nameconfigured_table_association
TypeResource
Descriptionconfigured_table_association
Idawscc.cleanrooms.configured_table_association
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
configured_table_association_identifierstring
configured_table_identifierstring
descriptionstring
membership_identifierstring
namestring
role_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configured_table_association resource, the following permissions are required: + +### Read +
+cleanrooms:GetConfiguredTableAssociation,
+cleanrooms:ListTagsForResource
+ +### Update +
+cleanrooms:UpdateConfiguredTableAssociation,
+cleanrooms:GetConfiguredTableAssociation,
+iam:PassRole,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:UntagResource
+ +### Delete +
+cleanrooms:DeleteConfiguredTableAssociation,
+cleanrooms:GetConfiguredTableAssociation,
+cleanrooms:ListConfiguredTableAssociations,
+cleanrooms:ListTagsForResource,
+cleanrooms:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +tags, +configured_table_association_identifier, +configured_table_identifier, +description, +membership_identifier, +name, +role_arn +FROM awscc.cleanrooms.configured_table_association +WHERE region = 'us-east-1' +AND data__Identifier = '<ConfiguredTableAssociationIdentifier>' +AND data__Identifier = '<MembershipIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_associations/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_associations/index.md new file mode 100644 index 0000000000..333a0593f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_associations/index.md @@ -0,0 +1,65 @@ +--- +title: configured_table_associations +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_associations + - 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 +--- +Retrieves a list of configured_table_associations in a region + +## Overview + + + + + +
Nameconfigured_table_associations
TypeResource
Descriptionconfigured_table_associations
Idawscc.cleanrooms.configured_table_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
configured_table_association_identifierstring
membership_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configured_table_associations resource, the following permissions are required: + +### Create +
+cleanrooms:CreateConfiguredTableAssociation,
+iam:PassRole,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:GetConfiguredTableAssociation,
+cleanrooms:ListConfiguredTableAssociations
+ +### List +
+cleanrooms:ListConfiguredTableAssociations
+ + +## Example +```sql +SELECT +region, +configured_table_association_identifier, +membership_identifier +FROM awscc.cleanrooms.configured_table_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md new file mode 100644 index 0000000000..fd7c2d9cb8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md @@ -0,0 +1,74 @@ +--- +title: configured_tables +hide_title: false +hide_table_of_contents: false +keywords: + - configured_tables + - 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 +--- +Retrieves a list of configured_tables in a region + +## Overview + + + + + +
Nameconfigured_tables
TypeResource
Descriptionconfigured_tables
Idawscc.cleanrooms.configured_tables
+ +## Fields + + + + + +
NameDatatypeDescription
configured_table_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configured_tables resource, the following permissions are required: + +### Create +
+cleanrooms:CreateConfiguredTable,
+cleanrooms:DeleteConfiguredTable,
+cleanrooms:DeleteConfiguredTableAnalysisRule,
+cleanrooms:CreateConfiguredTableAnalysisRule,
+cleanrooms:GetConfiguredTable,
+cleanrooms:GetConfiguredTableAnalysisRule,
+glue:GetDatabase,
+glue:GetDatabases,
+glue:GetTable,
+glue:GetTables,
+glue:GetPartition,
+glue:GetPartitions,
+glue:BatchGetPartition,
+glue:GetSchemaVersion,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:ListConfiguredTables
+ +### List +
+cleanrooms:ListConfiguredTables
+ + +## Example +```sql +SELECT +region, +configured_table_identifier +FROM awscc.cleanrooms.configured_tables +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/index.md new file mode 100644 index 0000000000..1149e657c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/index.md @@ -0,0 +1,47 @@ +--- +title: cleanrooms +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cleanrooms service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+analysis_template
+analysis_templates
+collaboration
+collaborations
+configured_table +
+
+configured_table_association
+configured_table_associations
+configured_tables
+membership
+memberships +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/membership/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/membership/index.md new file mode 100644 index 0000000000..9fea91ca28 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/membership/index.md @@ -0,0 +1,105 @@ +--- +title: membership +hide_title: false +hide_table_of_contents: false +keywords: + - membership + - 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 +--- +Gets an individual membership resource + +## Overview + + + + + +
Namemembership
TypeResource
Descriptionmembership
Idawscc.cleanrooms.membership
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms membership.
collaboration_arnstring
collaboration_creator_account_idstring
collaboration_identifierstring
membership_identifierstring
query_log_statusstring
default_result_configurationobject
payment_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the membership resource, the following permissions are required: + +### Read +
+cleanrooms:GetMembership,
+cleanrooms:ListTagsForResource,
+logs:ListLogDeliveries,
+logs:DescribeLogGroups,
+logs:DescribeResourcePolicies,
+logs:GetLogDelivery
+ +### Update +
+cleanrooms:UpdateMembership,
+cleanrooms:GetMembership,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:DescribeLogGroups,
+logs:DescribeResourcePolicies,
+logs:PutResourcePolicy,
+logs:CreateLogGroup,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:UntagResource,
+iam:PassRole
+ +### Delete +
+cleanrooms:DeleteMembership,
+cleanrooms:GetMembership,
+cleanrooms:ListMemberships,
+cleanrooms:ListTagsForResource,
+logs:ListLogDeliveries,
+logs:DescribeLogGroups,
+logs:DescribeResourcePolicies,
+logs:GetLogDelivery
+ + +## Example +```sql +SELECT +region, +arn, +tags, +collaboration_arn, +collaboration_creator_account_id, +collaboration_identifier, +membership_identifier, +query_log_status, +default_result_configuration, +payment_configuration +FROM awscc.cleanrooms.membership +WHERE region = 'us-east-1' +AND data__Identifier = '<MembershipIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md new file mode 100644 index 0000000000..0a5f9a0f2b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md @@ -0,0 +1,72 @@ +--- +title: memberships +hide_title: false +hide_table_of_contents: false +keywords: + - memberships + - 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 +--- +Retrieves a list of memberships in a region + +## Overview + + + + + +
Namememberships
TypeResource
Descriptionmemberships
Idawscc.cleanrooms.memberships
+ +## Fields + + + + + +
NameDatatypeDescription
membership_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the memberships resource, the following permissions are required: + +### Create +
+cleanrooms:CreateMembership,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:DescribeLogGroups,
+logs:DescribeResourcePolicies,
+logs:PutResourcePolicy,
+logs:CreateLogGroup,
+cleanrooms:GetMembership,
+cleanrooms:ListTagsForResource,
+cleanrooms:TagResource,
+cleanrooms:ListMemberships,
+iam:PassRole
+ +### List +
+cleanrooms:ListMemberships
+ + +## Example +```sql +SELECT +region, +membership_identifier +FROM awscc.cleanrooms.memberships +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloud_control/index.md b/docs/awscc-docs/providers/awscc/cloud_control/index.md new file mode 100644 index 0000000000..fd3dc14614 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloud_control/index.md @@ -0,0 +1,49 @@ +--- +title: cloud_control +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_control + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +cloud_control + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 8
+
+
+ +::: + +## Overview + + + + + + +
Nameawscc.cloud_control
TypeService
Titlecloud_control
Descriptioncloud_control
Idcloud_control:v23.11.00181
+ +## Resources +
+
+resource
+resource_request
+
+
+resource_requests
+resources
+
+
diff --git a/docs/awscc-docs/providers/awscc/cloud_control/resource/index.md b/docs/awscc-docs/providers/awscc/cloud_control/resource/index.md new file mode 100644 index 0000000000..682915afff --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloud_control/resource/index.md @@ -0,0 +1,35 @@ +--- +title: resource +hide_title: false +hide_table_of_contents: false +keywords: + - resource + - cloud_control + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + + + +## Overview + + + + +
Nameresource
TypeResource
Idawscc.cloud_control.resources
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| `Properties` | `string` | +| `Identifier` | `string` | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `get_resource` | `SELECT` | `data__Identifier, data__TypeName, region` | diff --git a/docs/awscc-docs/providers/awscc/cloud_control/resource_request/index.md b/docs/awscc-docs/providers/awscc/cloud_control/resource_request/index.md new file mode 100644 index 0000000000..e75aef99e8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloud_control/resource_request/index.md @@ -0,0 +1,43 @@ +--- +title: resource_request +hide_title: false +hide_table_of_contents: false +keywords: + - resource_request + - cloud_control + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + + + +## Overview + + + + +
Nameresource_request
TypeResource
Idawscc.cloud_control.resource_request
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| `EventTime` | `number` | +| `OperationStatus` | `string` | +| `StatusMessage` | `string` | +| `RetryAfter` | `number` | +| `ResourceModel` | `string` | +| `TypeName` | `string` | +| `ErrorCode` | `string` | +| `Identifier` | `string` | +| `Operation` | `string` | +| `RequestToken` | `string` | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `get_resource_request` | `SELECT` | `data__RequestToken, region` | diff --git a/docs/awscc-docs/providers/awscc/cloud_control/resource_requests/index.md b/docs/awscc-docs/providers/awscc/cloud_control/resource_requests/index.md new file mode 100644 index 0000000000..0fba39741a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloud_control/resource_requests/index.md @@ -0,0 +1,44 @@ +--- +title: resource_requests +hide_title: false +hide_table_of_contents: false +keywords: + - resource_requests + - cloud_control + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + + + +## Overview + + + + +
Nameresource_requests
TypeResource
Idawscc.cloud_control.resource_requests
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| `TypeName` | `string` | +| `ErrorCode` | `string` | +| `EventTime` | `number` | +| `Operation` | `string` | +| `OperationStatus` | `string` | +| `ResourceModel` | `string` | +| `RetryAfter` | `number` | +| `StatusMessage` | `string` | +| `Identifier` | `string` | +| `RequestToken` | `string` | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `list_resource_requests` | `SELECT` | `data__ResourceRequestStatusFilter, region` | +| `cancel_resource_request` | `DELETE` | `data__RequestToken, region` | diff --git a/docs/awscc-docs/providers/awscc/cloud_control/resources/index.md b/docs/awscc-docs/providers/awscc/cloud_control/resources/index.md new file mode 100644 index 0000000000..6fef07717e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloud_control/resources/index.md @@ -0,0 +1,38 @@ +--- +title: resources +hide_title: false +hide_table_of_contents: false +keywords: + - resources + - cloud_control + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + + + +## Overview + + + + +
Nameresources
TypeResource
Idawscc.cloud_control.resources
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| `Identifier` | `string` | +| `Properties` | `string` | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `list_resources` | `SELECT` | `data__TypeName, region` | +| `create_resource` | `INSERT` | `data__DesiredState, data__TypeName, region` | +| `delete_resource` | `DELETE` | `data__Identifier, data__TypeName, region` | +| `update_resource` | `UPDATE` | `data__Identifier, data__PatchDocument, data__TypeName, region` | diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_default_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_default_version/index.md new file mode 100644 index 0000000000..01174b6ce5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/hook_default_version/index.md @@ -0,0 +1,69 @@ +--- +title: hook_default_version +hide_title: false +hide_table_of_contents: false +keywords: + - hook_default_version + - 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 +--- +Gets an individual hook_default_version resource + +## Overview + + + + + +
Namehook_default_version
TypeResource
Descriptionhook_default_version
Idawscc.cloudformation.hook_default_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
type_version_arnstringThe Amazon Resource Name (ARN) of the type version.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
version_idstringThe ID of an existing version of the hook to set as the default.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hook_default_version resource, the following permissions are required: + +### Read +
+cloudformation:DescribeType
+ +### Update +
+cloudformation:SetTypeDefaultVersion
+ +### Delete +
+
+ + +## Example +```sql +SELECT +region, +type_version_arn, +type_name, +arn, +version_id +FROM awscc.cloudformation.hook_default_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_default_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_default_versions/index.md new file mode 100644 index 0000000000..6dd279c28e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/hook_default_versions/index.md @@ -0,0 +1,58 @@ +--- +title: hook_default_versions +hide_title: false +hide_table_of_contents: false +keywords: + - hook_default_versions + - 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 +--- +Retrieves a list of hook_default_versions in a region + +## Overview + + + + + +
Namehook_default_versions
TypeResource
Descriptionhook_default_versions
Idawscc.cloudformation.hook_default_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hook_default_versions resource, the following permissions are required: + +### Create +
+cloudformation:SetTypeDefaultVersion
+ +### List +
+cloudformation:ListTypes
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudformation.hook_default_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_type_config/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_type_config/index.md new file mode 100644 index 0000000000..3378034c9e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/hook_type_config/index.md @@ -0,0 +1,71 @@ +--- +title: hook_type_config +hide_title: false +hide_table_of_contents: false +keywords: + - hook_type_config + - 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 +--- +Gets an individual hook_type_config resource + +## Overview + + + + + +
Namehook_type_config
TypeResource
Descriptionhook_type_config
Idawscc.cloudformation.hook_type_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
type_arnstringThe Amazon Resource Name (ARN) of the type without version number.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
configuration_arnstringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
configurationstringThe configuration data for the extension, in this account and region.
configuration_aliasstringAn alias by which to refer to this extension configuration data.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hook_type_config resource, the following permissions are required: + +### Read +
+cloudformation:BatchDescribeTypeConfigurations
+ +### Update +
+cloudformation:SetTypeConfiguration
+ +### Delete +
+cloudformation:SetTypeConfiguration
+ + +## Example +```sql +SELECT +region, +type_arn, +type_name, +configuration_arn, +configuration, +configuration_alias +FROM awscc.cloudformation.hook_type_config +WHERE region = 'us-east-1' +AND data__Identifier = '<ConfigurationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_type_configs/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_type_configs/index.md new file mode 100644 index 0000000000..2e0da020a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/hook_type_configs/index.md @@ -0,0 +1,59 @@ +--- +title: hook_type_configs +hide_title: false +hide_table_of_contents: false +keywords: + - hook_type_configs + - 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 +--- +Retrieves a list of hook_type_configs in a region + +## Overview + + + + + +
Namehook_type_configs
TypeResource
Descriptionhook_type_configs
Idawscc.cloudformation.hook_type_configs
+ +## Fields + + + + + +
NameDatatypeDescription
configuration_arnstringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hook_type_configs resource, the following permissions are required: + +### Create +
+cloudformation:SetTypeConfiguration
+ +### List +
+cloudformation:ListTypes,
+cloudformation:BatchDescribeTypeConfigurations
+ + +## Example +```sql +SELECT +region, +configuration_arn +FROM awscc.cloudformation.hook_type_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md new file mode 100644 index 0000000000..c919fa8bbf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md @@ -0,0 +1,76 @@ +--- +title: hook_version +hide_title: false +hide_table_of_contents: false +keywords: + - hook_version + - 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 +--- +Gets an individual hook_version resource + +## Overview + + + + + +
Namehook_version
TypeResource
Descriptionhook_version
Idawscc.cloudformation.hook_version
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
type_arnstringThe Amazon Resource Name (ARN) of the type without the versionID.
execution_role_arnstringThe 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.
is_default_versionbooleanIndicates if this type version is the current default version
logging_configobjectSpecifies logging configuration information for a type.
schema_handler_packagestringA 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.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
version_idstringThe ID of the version of the type represented by this hook instance.
visibilitystringThe scope at which the type is visible and usable in CloudFormation operations.<br/><br/>Valid values include:<br/><br/>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.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hook_version resource, the following permissions are required: + +### Read +
+cloudformation:DescribeType
+ +### Delete +
+cloudformation:DeregisterType,
+cloudformation:DescribeType
+ + +## Example +```sql +SELECT +region, +arn, +type_arn, +execution_role_arn, +is_default_version, +logging_config, +schema_handler_package, +type_name, +version_id, +visibility +FROM awscc.cloudformation.hook_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md new file mode 100644 index 0000000000..d00c6065a2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md @@ -0,0 +1,65 @@ +--- +title: hook_versions +hide_title: false +hide_table_of_contents: false +keywords: + - hook_versions + - 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 +--- +Retrieves a list of hook_versions in a region + +## Overview + + + + + +
Namehook_versions
TypeResource
Descriptionhook_versions
Idawscc.cloudformation.hook_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hook_versions resource, the following permissions are required: + +### Create +
+cloudformation:DescribeType,
+cloudformation:DescribeTypeRegistration,
+cloudformation:RegisterType,
+iam:PassRole,
+s3:GetObject,
+s3:ListBucket,
+kms:Decrypt
+ +### List +
+cloudformation:ListTypes,
+cloudformation:ListTypeVersions
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudformation.hook_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/index.md b/docs/awscc-docs/providers/awscc/cloudformation/index.md new file mode 100644 index 0000000000..2ced34b8b8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/index.md @@ -0,0 +1,61 @@ +--- +title: cloudformation +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cloudformation service documentation. + +:::info Service Summary + +
+
+total resources: 24
+total selectable resources: 24
+total methods: 24
+
+
+ +::: + +## Resources +
+
+hook_default_version
+hook_default_versions
+hook_type_config
+hook_type_configs
+hook_version
+hook_versions
+module_default_version
+module_default_versions
+module_version
+module_versions
+public_type_version
+public_type_versions +
+
+publisher
+publishers
+resource_default_version
+resource_default_versions
+resource_version
+resource_versions
+stack
+stack_set
+stack_sets
+stacks
+type_activation
+type_activations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cloudformation/module_default_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/module_default_version/index.md new file mode 100644 index 0000000000..2effdf6f2f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/module_default_version/index.md @@ -0,0 +1,63 @@ +--- +title: module_default_version +hide_title: false +hide_table_of_contents: false +keywords: + - module_default_version + - 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 +--- +Gets an individual module_default_version resource + +## Overview + + + + + +
Namemodule_default_version
TypeResource
Descriptionmodule_default_version
Idawscc.cloudformation.module_default_version
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module version to set as the default version.
module_namestringThe name of a module existing in the registry.
version_idstringThe ID of an existing version of the named module to set as the default.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the module_default_version resource, the following permissions are required: + +### Delete +
+
+ +### Read +
+cloudformation:DescribeType
+ + +## Example +```sql +SELECT +region, +arn, +module_name, +version_id +FROM awscc.cloudformation.module_default_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/module_default_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/module_default_versions/index.md new file mode 100644 index 0000000000..a167d897d7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/module_default_versions/index.md @@ -0,0 +1,59 @@ +--- +title: module_default_versions +hide_title: false +hide_table_of_contents: false +keywords: + - module_default_versions + - 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 +--- +Retrieves a list of module_default_versions in a region + +## Overview + + + + + +
Namemodule_default_versions
TypeResource
Descriptionmodule_default_versions
Idawscc.cloudformation.module_default_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module version to set as the default version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the module_default_versions resource, the following permissions are required: + +### Create +
+cloudformation:DescribeType,
+cloudformation:SetTypeDefaultVersion
+ +### List +
+cloudformation:ListTypes
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudformation.module_default_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md new file mode 100644 index 0000000000..f21cec38f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md @@ -0,0 +1,78 @@ +--- +title: module_version +hide_title: false +hide_table_of_contents: false +keywords: + - module_version + - 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 +--- +Gets an individual module_version resource + +## Overview + + + + + +
Namemodule_version
TypeResource
Descriptionmodule_version
Idawscc.cloudformation.module_version
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module.
descriptionstringThe description of the registered module.
documentation_urlstringThe URL of a page providing detailed documentation for this module.
module_namestringThe name of the module being registered.<br/><br/>Recommended module naming pattern: company_or_organization::service::type::MODULE.
module_packagestringThe url to the S3 bucket containing the schema and template fragment for the module you want to register.
is_default_versionbooleanIndicator of whether this module version is the current default version
schemastringThe schema defining input parameters to and resources generated by the module.
time_createdstringThe time that the specified module version was registered.
version_idstringThe version ID of the module represented by this module instance.
visibilitystringThe scope at which the type is visible and usable in CloudFormation operations.<br/><br/>The only allowed value at present is:<br/><br/>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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the module_version resource, the following permissions are required: + +### Read +
+cloudformation:DescribeType
+ +### Delete +
+cloudformation:DeregisterType,
+cloudformation:DescribeType
+ + +## Example +```sql +SELECT +region, +arn, +description, +documentation_url, +module_name, +module_package, +is_default_version, +schema, +time_created, +version_id, +visibility +FROM awscc.cloudformation.module_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/module_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/module_versions/index.md new file mode 100644 index 0000000000..1b3b779aac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/module_versions/index.md @@ -0,0 +1,59 @@ +--- +title: module_versions +hide_title: false +hide_table_of_contents: false +keywords: + - module_versions + - 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 +--- +Retrieves a list of module_versions in a region + +## Overview + + + + + +
Namemodule_versions
TypeResource
Descriptionmodule_versions
Idawscc.cloudformation.module_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the module_versions resource, the following permissions are required: + +### Create +
+cloudformation:DescribeType,
+cloudformation:DescribeTypeRegistration,
+cloudformation:ListTypeVersions,
+cloudformation:RegisterType,
+s3:GetObject,
+s3:ListBucket
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudformation.module_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/public_type_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/public_type_version/index.md new file mode 100644 index 0000000000..f9f3c400ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/public_type_version/index.md @@ -0,0 +1,74 @@ +--- +title: public_type_version +hide_title: false +hide_table_of_contents: false +keywords: + - public_type_version + - 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 +--- +Gets an individual public_type_version resource + +## Overview + + + + + +
Namepublic_type_version
TypeResource
Descriptionpublic_type_version
Idawscc.cloudformation.public_type_version
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Number (ARN) of the extension.
type_version_arnstringThe Amazon Resource Number (ARN) of the extension with the versionId.
public_version_numberstringThe version number of a public third-party extension
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
public_type_arnstringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
log_delivery_bucketstringA url to the S3 bucket where logs for the testType run will be available
typestringThe kind of extension
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the public_type_version resource, the following permissions are required: + +### Delete +
+
+ +### Read +
+cloudformation:DescribeType,
+cloudformation:DescribePublisher
+ + +## Example +```sql +SELECT +region, +arn, +type_version_arn, +public_version_number, +publisher_id, +public_type_arn, +type_name, +log_delivery_bucket, +type +FROM awscc.cloudformation.public_type_version +WHERE region = 'us-east-1' +AND data__Identifier = '<PublicTypeArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/public_type_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/public_type_versions/index.md new file mode 100644 index 0000000000..df6ddb0670 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/public_type_versions/index.md @@ -0,0 +1,63 @@ +--- +title: public_type_versions +hide_title: false +hide_table_of_contents: false +keywords: + - public_type_versions + - 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 +--- +Retrieves a list of public_type_versions in a region + +## Overview + + + + + +
Namepublic_type_versions
TypeResource
Descriptionpublic_type_versions
Idawscc.cloudformation.public_type_versions
+ +## Fields + + + + + +
NameDatatypeDescription
public_type_arnstringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the public_type_versions resource, the following permissions are required: + +### Create +
+cloudformation:TestType,
+cloudformation:DescribeType,
+cloudformation:PublishType,
+cloudformation:DescribePublisher,
+s3:GetObject,
+s3:PutObject
+ +### List +
+cloudformation:ListTypes
+ + +## Example +```sql +SELECT +region, +public_type_arn +FROM awscc.cloudformation.public_type_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md b/docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md new file mode 100644 index 0000000000..e888b9534e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md @@ -0,0 +1,69 @@ +--- +title: publisher +hide_title: false +hide_table_of_contents: false +keywords: + - publisher + - 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 +--- +Gets an individual publisher resource + +## Overview + + + + + +
Namepublisher
TypeResource
Descriptionpublisher
Idawscc.cloudformation.publisher
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
accept_terms_and_conditionsbooleanWhether 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
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
connection_arnstringIf you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
publisher_statusstringWhether the publisher is verified.
publisher_profilestringThe URL to the publisher's profile with the identity provider.
identity_providerstringThe type of account used as the identity provider when registering this publisher with CloudFormation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the publisher resource, the following permissions are required: + +### Read +
+cloudformation:DescribePublisher
+ +### Delete +
+
+ + +## Example +```sql +SELECT +region, +accept_terms_and_conditions, +publisher_id, +connection_arn, +publisher_status, +publisher_profile, +identity_provider +FROM awscc.cloudformation.publisher +WHERE region = 'us-east-1' +AND data__Identifier = '<PublisherId>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md b/docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md new file mode 100644 index 0000000000..bac8100232 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md @@ -0,0 +1,61 @@ +--- +title: publishers +hide_title: false +hide_table_of_contents: false +keywords: + - publishers + - 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 +--- +Retrieves a list of publishers in a region + +## Overview + + + + + +
Namepublishers
TypeResource
Descriptionpublishers
Idawscc.cloudformation.publishers
+ +## Fields + + + + + +
NameDatatypeDescription
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the publishers resource, the following permissions are required: + +### Create +
+cloudformation:RegisterPublisher,
+cloudformation:DescribePublisher,
+codestar-connections:GetConnection,
+codestar-connections:UseConnection
+ +### List +
+cloudformation:DescribePublisher
+ + +## Example +```sql +SELECT +region, +publisher_id +FROM awscc.cloudformation.publishers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/resource_default_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/resource_default_version/index.md new file mode 100644 index 0000000000..c579354ddc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/resource_default_version/index.md @@ -0,0 +1,69 @@ +--- +title: resource_default_version +hide_title: false +hide_table_of_contents: false +keywords: + - resource_default_version + - 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 +--- +Gets an individual resource_default_version resource + +## Overview + + + + + +
Nameresource_default_version
TypeResource
Descriptionresource_default_version
Idawscc.cloudformation.resource_default_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
version_idstringThe ID of an existing version of the resource to set as the default.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
type_version_arnstringThe Amazon Resource Name (ARN) of the type version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_default_version resource, the following permissions are required: + +### Read +
+cloudformation:DescribeType
+ +### Update +
+cloudformation:SetTypeDefaultVersion
+ +### Delete +
+
+ + +## Example +```sql +SELECT +region, +version_id, +type_name, +arn, +type_version_arn +FROM awscc.cloudformation.resource_default_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/resource_default_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/resource_default_versions/index.md new file mode 100644 index 0000000000..b28a5a6a84 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/resource_default_versions/index.md @@ -0,0 +1,58 @@ +--- +title: resource_default_versions +hide_title: false +hide_table_of_contents: false +keywords: + - resource_default_versions + - 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 +--- +Retrieves a list of resource_default_versions in a region + +## Overview + + + + + +
Nameresource_default_versions
TypeResource
Descriptionresource_default_versions
Idawscc.cloudformation.resource_default_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_default_versions resource, the following permissions are required: + +### Create +
+cloudformation:SetTypeDefaultVersion
+ +### List +
+cloudformation:ListTypeVersions
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudformation.resource_default_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md new file mode 100644 index 0000000000..6aa002313b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md @@ -0,0 +1,78 @@ +--- +title: resource_version +hide_title: false +hide_table_of_contents: false +keywords: + - resource_version + - 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 +--- +Gets an individual resource_version resource + +## Overview + + + + + +
Nameresource_version
TypeResource
Descriptionresource_version
Idawscc.cloudformation.resource_version
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
type_arnstringThe Amazon Resource Name (ARN) of the type without the versionID.
execution_role_arnstringThe 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.
is_default_versionbooleanIndicates if this type version is the current default version
logging_configobjectSpecifies logging configuration information for a type.
provisioning_typestringThe 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.
schema_handler_packagestringA 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.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
version_idstringThe ID of the version of the type represented by this resource instance.
visibilitystringThe scope at which the type is visible and usable in CloudFormation operations.<br/><br/>Valid values include:<br/><br/>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.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_version resource, the following permissions are required: + +### Read +
+cloudformation:DescribeType
+ +### Delete +
+cloudformation:DeregisterType,
+cloudformation:DescribeType
+ + +## Example +```sql +SELECT +region, +arn, +type_arn, +execution_role_arn, +is_default_version, +logging_config, +provisioning_type, +schema_handler_package, +type_name, +version_id, +visibility +FROM awscc.cloudformation.resource_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md new file mode 100644 index 0000000000..06aec0752c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md @@ -0,0 +1,66 @@ +--- +title: resource_versions +hide_title: false +hide_table_of_contents: false +keywords: + - resource_versions + - 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 +--- +Retrieves a list of resource_versions in a region + +## Overview + + + + + +
Nameresource_versions
TypeResource
Descriptionresource_versions
Idawscc.cloudformation.resource_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_versions resource, the following permissions are required: + +### Create +
+cloudformation:DescribeTypeRegistration,
+cloudformation:RegisterType,
+iam:PassRole,
+s3:GetObject,
+s3:ListBucket,
+kms:Decrypt,
+cloudformation:ListTypeVersions,
+cloudformation:DeregisterType,
+cloudformation:DescribeType
+ +### List +
+cloudformation:ListTypes
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudformation.resource_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stack/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stack/index.md new file mode 100644 index 0000000000..f615307e51 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/stack/index.md @@ -0,0 +1,114 @@ +--- +title: stack +hide_title: false +hide_table_of_contents: false +keywords: + - stack + - 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 +--- +Gets an individual stack resource + +## Overview + + + + + +
Namestack
TypeResource
Descriptionstack
Idawscc.cloudformation.stack
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
capabilitiesarray
role_ar_nstring
outputsarray
descriptionstring
disable_rollbackboolean
enable_termination_protectionboolean
notification_ar_nsarray
parametersobject
parent_idstring
root_idstring
change_set_idstring
stack_namestring
stack_idstring
stack_policy_bodyobject
stack_policy_ur_lstring
stack_statusstring
stack_status_reasonstring
tagsarray
template_bodyobject
template_ur_lstring
timeout_in_minutesinteger
last_update_timestring
creation_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stack resource, the following permissions are required: + +### Update +
+cloudformation:DescribeStacks,
+cloudformation:UpdateStack,
+cloudformation:UpdateTerminationProtection,
+cloudformation:SetStackPolicy,
+iam:PassRole
+ +### Delete +
+cloudformation:DescribeStacks,
+cloudformation:DeleteStack
+ +### Read +
+cloudformation:DescribeStacks,
+cloudformation:GetStackPolicy,
+cloudformation:GetTemplate
+ + +## Example +```sql +SELECT +region, +capabilities, +role_ar_n, +outputs, +description, +disable_rollback, +enable_termination_protection, +notification_ar_ns, +parameters, +parent_id, +root_id, +change_set_id, +stack_name, +stack_id, +stack_policy_body, +stack_policy_ur_l, +stack_status, +stack_status_reason, +tags, +template_body, +template_ur_l, +timeout_in_minutes, +last_update_time, +creation_time +FROM awscc.cloudformation.stack +WHERE region = 'us-east-1' +AND data__Identifier = '<StackId>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md new file mode 100644 index 0000000000..11bbd875ee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md @@ -0,0 +1,110 @@ +--- +title: stack_set +hide_title: false +hide_table_of_contents: false +keywords: + - stack_set + - 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 +--- +Gets an individual stack_set resource + +## Overview + + + + + +
Namestack_set
TypeResource
Descriptionstack_set
Idawscc.cloudformation.stack_set
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stack_set_namestringThe name to associate with the stack set. The name must be unique in the Region where you create your stack set.
stack_set_idstringThe ID of the stack set that you're creating.
administration_role_ar_nstringThe 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.
auto_deploymentobjectDescribes 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.
capabilitiesarrayIn 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.
descriptionstringA description of the stack set. You can use the description to identify the stack set's purpose or other important information.
execution_role_namestringThe 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.
operation_preferencesobject
stack_instances_grouparrayA group of stack instances with parameters in some specific accounts and regions.
parametersarrayThe input parameters for the stack set template.
permission_modelstringDescribes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
tagsarrayThe 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.
template_bodystringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
template_ur_lstringLocation 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.
call_asstringSpecifies 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.
managed_executionobjectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stack_set resource, the following permissions are required: + +### Read +
+cloudformation:DescribeStackSet,
+cloudformation:ListStackInstances,
+cloudformation:DescribeStackInstance
+ +### Update +
+cloudformation:GetTemplateSummary,
+cloudformation:UpdateStackSet,
+cloudformation:CreateStackInstances,
+cloudformation:DeleteStackInstances,
+cloudformation:UpdateStackInstances,
+cloudformation:DescribeStackSet,
+cloudformation:DescribeStackSetOperation,
+cloudformation:ListStackSetOperationResults,
+cloudformation:TagResource,
+cloudformation:UntagResource,
+iam:PassRole
+ +### Delete +
+cloudformation:DeleteStackSet,
+cloudformation:DeleteStackInstances,
+cloudformation:DescribeStackSet,
+cloudformation:DescribeStackSetOperation,
+cloudformation:ListStackSetOperationResults,
+cloudformation:UntagResource
+ + +## Example +```sql +SELECT +region, +stack_set_name, +stack_set_id, +administration_role_ar_n, +auto_deployment, +capabilities, +description, +execution_role_name, +operation_preferences, +stack_instances_group, +parameters, +permission_model, +tags, +template_body, +template_ur_l, +call_as, +managed_execution +FROM awscc.cloudformation.stack_set +WHERE region = 'us-east-1' +AND data__Identifier = '<StackSetId>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md new file mode 100644 index 0000000000..d1e8267887 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md @@ -0,0 +1,67 @@ +--- +title: stack_sets +hide_title: false +hide_table_of_contents: false +keywords: + - stack_sets + - 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 +--- +Retrieves a list of stack_sets in a region + +## Overview + + + + + +
Namestack_sets
TypeResource
Descriptionstack_sets
Idawscc.cloudformation.stack_sets
+ +## Fields + + + + + +
NameDatatypeDescription
stack_set_idstringThe ID of the stack set that you're creating.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stack_sets resource, the following permissions are required: + +### Create +
+cloudformation:GetTemplateSummary,
+cloudformation:CreateStackSet,
+cloudformation:CreateStackInstances,
+cloudformation:DescribeStackSetOperation,
+cloudformation:ListStackSetOperationResults,
+cloudformation:TagResource,
+iam:PassRole
+ +### List +
+cloudformation:ListStackSets,
+cloudformation:DescribeStackSet,
+cloudformation:ListStackInstances,
+cloudformation:DescribeStackInstance
+ + +## Example +```sql +SELECT +region, +stack_set_id +FROM awscc.cloudformation.stack_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md new file mode 100644 index 0000000000..ab8550bd8c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md @@ -0,0 +1,60 @@ +--- +title: stacks +hide_title: false +hide_table_of_contents: false +keywords: + - stacks + - 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 +--- +Retrieves a list of stacks in a region + +## Overview + + + + + +
Namestacks
TypeResource
Descriptionstacks
Idawscc.cloudformation.stacks
+ +## Fields + + + + + +
NameDatatypeDescription
stack_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stacks resource, the following permissions are required: + +### Create +
+cloudformation:DescribeStacks,
+cloudformation:CreateStack,
+iam:PassRole
+ +### List +
+cloudformation:ListStacks
+ + +## Example +```sql +SELECT +region, +stack_id +FROM awscc.cloudformation.stacks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md b/docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md new file mode 100644 index 0000000000..d836041fb7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md @@ -0,0 +1,86 @@ +--- +title: type_activation +hide_title: false +hide_table_of_contents: false +keywords: + - type_activation + - 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 +--- +Gets an individual type_activation resource + +## Overview + + + + + +
Nametype_activation
TypeResource
Descriptiontype_activation
Idawscc.cloudformation.type_activation
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the extension.
execution_role_arnstringThe 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.
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
logging_configobjectSpecifies logging configuration information for a type.
public_type_arnstringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
auto_updatebooleanWhether 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.
type_name_aliasstringAn 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.
version_bumpstringManually 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
major_versionstringThe Major Version of the type you want to enable
type_namestringThe name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
typestringThe kind of extension
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the type_activation resource, the following permissions are required: + +### Update +
+cloudformation:ActivateType,
+cloudformation:DescribeType,
+iam:PassRole
+ +### Read +
+cloudformation:DescribeType
+ +### Delete +
+cloudformation:DeactivateType,
+cloudformation:DescribeType
+ + +## Example +```sql +SELECT +region, +arn, +execution_role_arn, +publisher_id, +logging_config, +public_type_arn, +auto_update, +type_name_alias, +version_bump, +major_version, +type_name, +type +FROM awscc.cloudformation.type_activation +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md b/docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md new file mode 100644 index 0000000000..b4762800f3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md @@ -0,0 +1,60 @@ +--- +title: type_activations +hide_title: false +hide_table_of_contents: false +keywords: + - type_activations + - 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 +--- +Retrieves a list of type_activations in a region + +## Overview + + + + + +
Nametype_activations
TypeResource
Descriptiontype_activations
Idawscc.cloudformation.type_activations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the extension.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the type_activations resource, the following permissions are required: + +### Create +
+cloudformation:ActivateType,
+cloudformation:DescribeType,
+iam:PassRole
+ +### List +
+cloudformation:ListTypes
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudformation.type_activations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md b/docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md new file mode 100644 index 0000000000..148b9ff1f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md @@ -0,0 +1,58 @@ +--- +title: cache_policies +hide_title: false +hide_table_of_contents: false +keywords: + - cache_policies + - 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 +--- +Retrieves a list of cache_policies in a region + +## Overview + + + + + +
Namecache_policies
TypeResource
Descriptioncache_policies
Idawscc.cloudfront.cache_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cache_policies resource, the following permissions are required: + +### Create +
+cloudfront:CreateCachePolicy
+ +### List +
+cloudfront:ListCachePolicies
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.cache_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md b/docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md new file mode 100644 index 0000000000..1f84ee17f7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md @@ -0,0 +1,68 @@ +--- +title: cache_policy +hide_title: false +hide_table_of_contents: false +keywords: + - cache_policy + - 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 +--- +Gets an individual cache_policy resource + +## Overview + + + + + +
Namecache_policy
TypeResource
Descriptioncache_policy
Idawscc.cloudfront.cache_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
cache_policy_configobject
idstring
last_modified_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cache_policy resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteCachePolicy,
+cloudfront:GetCachePolicy
+ +### Read +
+cloudfront:GetCachePolicy
+ +### Update +
+cloudfront:UpdateCachePolicy,
+cloudfront:GetCachePolicy
+ + +## Example +```sql +SELECT +region, +cache_policy_config, +id, +last_modified_time +FROM awscc.cloudfront.cache_policy +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identities/index.md b/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identities/index.md new file mode 100644 index 0000000000..b87e9ada9f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identities/index.md @@ -0,0 +1,58 @@ +--- +title: cloud_front_origin_access_identities +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_front_origin_access_identities + - 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 +--- +Retrieves a list of cloud_front_origin_access_identities in a region + +## Overview + + + + + +
Namecloud_front_origin_access_identities
TypeResource
Descriptioncloud_front_origin_access_identities
Idawscc.cloudfront.cloud_front_origin_access_identities
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cloud_front_origin_access_identities resource, the following permissions are required: + +### Create +
+cloudfront:CreateCloudFrontOriginAccessIdentity
+ +### List +
+cloudfront:ListCloudFrontOriginAccessIdentities
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.cloud_front_origin_access_identities + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identity/index.md b/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identity/index.md new file mode 100644 index 0000000000..df79b2c881 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identity/index.md @@ -0,0 +1,68 @@ +--- +title: cloud_front_origin_access_identity +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_front_origin_access_identity + - 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 +--- +Gets an individual cloud_front_origin_access_identity resource + +## Overview + + + + + +
Namecloud_front_origin_access_identity
TypeResource
Descriptioncloud_front_origin_access_identity
Idawscc.cloudfront.cloud_front_origin_access_identity
+ +## Fields + + + + + + + +
NameDatatypeDescription
cloud_front_origin_access_identity_configobject
idstring
s3_canonical_user_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cloud_front_origin_access_identity resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteCloudFrontOriginAccessIdentity,
+cloudfront:GetCloudFrontOriginAccessIdentity
+ +### Read +
+cloudfront:GetCloudFrontOriginAccessIdentity
+ +### Update +
+cloudfront:UpdateCloudFrontOriginAccessIdentity,
+cloudfront:GetCloudFrontOriginAccessIdentity
+ + +## Example +```sql +SELECT +region, +cloud_front_origin_access_identity_config, +id, +s3_canonical_user_id +FROM awscc.cloudfront.cloud_front_origin_access_identity +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policies/index.md b/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policies/index.md new file mode 100644 index 0000000000..2a0e10d26e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policies/index.md @@ -0,0 +1,58 @@ +--- +title: continuous_deployment_policies +hide_title: false +hide_table_of_contents: false +keywords: + - continuous_deployment_policies + - 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 +--- +Retrieves a list of continuous_deployment_policies in a region + +## Overview + + + + + +
Namecontinuous_deployment_policies
TypeResource
Descriptioncontinuous_deployment_policies
Idawscc.cloudfront.continuous_deployment_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the continuous_deployment_policies resource, the following permissions are required: + +### Create +
+cloudfront:CreateContinuousDeploymentPolicy
+ +### List +
+cloudfront:ListContinuousDeploymentPolicies
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.continuous_deployment_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policy/index.md b/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policy/index.md new file mode 100644 index 0000000000..acc37a2126 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policy/index.md @@ -0,0 +1,68 @@ +--- +title: continuous_deployment_policy +hide_title: false +hide_table_of_contents: false +keywords: + - continuous_deployment_policy + - 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 +--- +Gets an individual continuous_deployment_policy resource + +## Overview + + + + + +
Namecontinuous_deployment_policy
TypeResource
Descriptioncontinuous_deployment_policy
Idawscc.cloudfront.continuous_deployment_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
continuous_deployment_policy_configobject
idstring
last_modified_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the continuous_deployment_policy resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteContinuousDeploymentPolicy,
+cloudfront:GetContinuousDeploymentPolicy
+ +### Read +
+cloudfront:GetContinuousDeploymentPolicy
+ +### Update +
+cloudfront:UpdateContinuousDeploymentPolicy,
+cloudfront:GetContinuousDeploymentPolicy
+ + +## Example +```sql +SELECT +region, +continuous_deployment_policy_config, +id, +last_modified_time +FROM awscc.cloudfront.continuous_deployment_policy +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md b/docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md new file mode 100644 index 0000000000..b701642670 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md @@ -0,0 +1,77 @@ +--- +title: distribution +hide_title: false +hide_table_of_contents: false +keywords: + - distribution + - 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 +--- +Gets an individual distribution resource + +## Overview + + + + + +
Namedistribution
TypeResource
Descriptiondistribution
Idawscc.cloudfront.distribution
+ +## Fields + + + + + + + + +
NameDatatypeDescription
distribution_configobjectThe distribution's configuration.
domain_namestring
idstring
tagsarrayA complex type that contains zero or more ``Tag`` elements.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the distribution resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteDistribution,
+cloudfront:GetDistribution,
+cloudfront:GetDistributionConfig
+ +### Read +
+cloudfront:GetDistribution,
+cloudfront:GetDistributionConfig
+ +### Update +
+cloudfront:GetDistribution,
+cloudfront:GetDistributionConfig,
+cloudfront:UpdateDistribution,
+cloudfront:UpdateDistributionWithStagingConfig,
+cloudfront:ListTagsForResource,
+cloudfront:TagResource,
+cloudfront:UntagResource
+ + +## Example +```sql +SELECT +region, +distribution_config, +domain_name, +id, +tags +FROM awscc.cloudfront.distribution +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md b/docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md new file mode 100644 index 0000000000..8a692c26b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md @@ -0,0 +1,62 @@ +--- +title: distributions +hide_title: false +hide_table_of_contents: false +keywords: + - distributions + - 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 +--- +Retrieves a list of distributions in a region + +## Overview + + + + + +
Namedistributions
TypeResource
Descriptiondistributions
Idawscc.cloudfront.distributions
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the distributions resource, the following permissions are required: + +### Create +
+cloudfront:CreateDistribution,
+cloudfront:CreateDistributionWithTags,
+cloudfront:GetDistribution,
+cloudfront:GetDistributionConfig,
+cloudfront:TagResource
+ +### List +
+cloudfront:ListDistributions
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.distributions + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/function/index.md b/docs/awscc-docs/providers/awscc/cloudfront/function/index.md new file mode 100644 index 0000000000..f2a4efe0b4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/function/index.md @@ -0,0 +1,78 @@ +--- +title: function +hide_title: false +hide_table_of_contents: false +keywords: + - function + - 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 +--- +Gets an individual function resource + +## Overview + + + + + +
Namefunction
TypeResource
Descriptionfunction
Idawscc.cloudfront.function
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
auto_publishboolean
function_ar_nstring
function_codestring
function_configobject
function_metadataobject
namestring
stagestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the function resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteFunction,
+cloudfront:DescribeFunction
+ +### Read +
+cloudfront:DescribeFunction,
+cloudfront:GetFunction
+ +### Update +
+cloudfront:UpdateFunction,
+cloudfront:PublishFunction,
+cloudfront:DescribeFunction
+ + +## Example +```sql +SELECT +region, +auto_publish, +function_ar_n, +function_code, +function_config, +function_metadata, +name, +stage +FROM awscc.cloudfront.function +WHERE data__Identifier = '<FunctionARN>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/functions/index.md b/docs/awscc-docs/providers/awscc/cloudfront/functions/index.md new file mode 100644 index 0000000000..5e9295f76c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/functions/index.md @@ -0,0 +1,60 @@ +--- +title: functions +hide_title: false +hide_table_of_contents: false +keywords: + - functions + - 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 +--- +Retrieves a list of functions in a region + +## Overview + + + + + +
Namefunctions
TypeResource
Descriptionfunctions
Idawscc.cloudfront.functions
+ +## Fields + + + + + +
NameDatatypeDescription
function_ar_nstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the functions resource, the following permissions are required: + +### Create +
+cloudfront:CreateFunction,
+cloudfront:PublishFunction,
+cloudfront:DescribeFunction
+ +### List +
+cloudfront:ListFunctions
+ + +## Example +```sql +SELECT +region, +function_ar_n +FROM awscc.cloudfront.functions + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/index.md b/docs/awscc-docs/providers/awscc/cloudfront/index.md new file mode 100644 index 0000000000..a57552634e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/index.md @@ -0,0 +1,63 @@ +--- +title: cloudfront +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cloudfront service documentation. + +:::info Service Summary + +
+
+total resources: 26
+total selectable resources: 26
+total methods: 26
+
+
+ +::: + +## Resources +
+
+cache_policies
+cache_policy
+cloud_front_origin_access_identities
+cloud_front_origin_access_identity
+continuous_deployment_policies
+continuous_deployment_policy
+distribution
+distributions
+function
+functions
+key_group
+key_groups
+key_value_store +
+
+key_value_stores
+monitoring_subscription
+monitoring_subscriptions
+origin_access_control
+origin_access_controls
+origin_request_policies
+origin_request_policy
+public_key
+public_keys
+realtime_log_config
+realtime_log_configs
+response_headers_policies
+response_headers_policy +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cloudfront/key_group/index.md b/docs/awscc-docs/providers/awscc/cloudfront/key_group/index.md new file mode 100644 index 0000000000..a016a7b20e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/key_group/index.md @@ -0,0 +1,68 @@ +--- +title: key_group +hide_title: false +hide_table_of_contents: false +keywords: + - key_group + - 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 +--- +Gets an individual key_group resource + +## Overview + + + + + +
Namekey_group
TypeResource
Descriptionkey_group
Idawscc.cloudfront.key_group
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
key_group_configobject
last_modified_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the key_group resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteKeyGroup,
+cloudfront:GetKeyGroup
+ +### Read +
+cloudfront:GetKeyGroup
+ +### Update +
+cloudfront:UpdateKeyGroup,
+cloudfront:GetKeyGroup
+ + +## Example +```sql +SELECT +region, +id, +key_group_config, +last_modified_time +FROM awscc.cloudfront.key_group +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md b/docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md new file mode 100644 index 0000000000..c32765eddf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md @@ -0,0 +1,58 @@ +--- +title: key_groups +hide_title: false +hide_table_of_contents: false +keywords: + - key_groups + - 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 +--- +Retrieves a list of key_groups in a region + +## Overview + + + + + +
Namekey_groups
TypeResource
Descriptionkey_groups
Idawscc.cloudfront.key_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the key_groups resource, the following permissions are required: + +### Create +
+cloudfront:CreateKeyGroup
+ +### List +
+cloudfront:ListKeyGroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.key_groups + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/key_value_store/index.md b/docs/awscc-docs/providers/awscc/cloudfront/key_value_store/index.md new file mode 100644 index 0000000000..58fb542691 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/key_value_store/index.md @@ -0,0 +1,74 @@ +--- +title: key_value_store +hide_title: false +hide_table_of_contents: false +keywords: + - key_value_store + - 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 +--- +Gets an individual key_value_store resource + +## Overview + + + + + +
Namekey_value_store
TypeResource
Descriptionkey_value_store
Idawscc.cloudfront.key_value_store
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
idstring
statusstring
namestring
commentstring
import_sourceobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the key_value_store resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteKeyValueStore,
+cloudfront:DescribeKeyValueStore
+ +### Read +
+cloudfront:DescribeKeyValueStore
+ +### Update +
+cloudfront:UpdateKeyValueStore,
+cloudfront:DescribeKeyValueStore
+ + +## Example +```sql +SELECT +region, +arn, +id, +status, +name, +comment, +import_source +FROM awscc.cloudfront.key_value_store +WHERE data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/key_value_stores/index.md b/docs/awscc-docs/providers/awscc/cloudfront/key_value_stores/index.md new file mode 100644 index 0000000000..253c02dc93 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/key_value_stores/index.md @@ -0,0 +1,62 @@ +--- +title: key_value_stores +hide_title: false +hide_table_of_contents: false +keywords: + - key_value_stores + - 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 +--- +Retrieves a list of key_value_stores in a region + +## Overview + + + + + +
Namekey_value_stores
TypeResource
Descriptionkey_value_stores
Idawscc.cloudfront.key_value_stores
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the key_value_stores resource, the following permissions are required: + +### Create +
+cloudfront:CreateKeyValueStore,
+cloudfront:DescribeKeyValueStore,
+s3:GetObject,
+s3:HeadObject,
+s3:GetBucketLocation
+ +### List +
+cloudfront:ListKeyValueStores
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.cloudfront.key_value_stores + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md b/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md new file mode 100644 index 0000000000..84efb431be --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md @@ -0,0 +1,60 @@ +--- +title: monitoring_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_subscription + - 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 +--- +Gets an individual monitoring_subscription resource + +## Overview + + + + + +
Namemonitoring_subscription
TypeResource
Descriptionmonitoring_subscription
Idawscc.cloudfront.monitoring_subscription
+ +## Fields + + + + + + +
NameDatatypeDescription
distribution_idstring
monitoring_subscriptionobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the monitoring_subscription resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteMonitoringSubscription
+ +### Read +
+cloudfront:GetMonitoringSubscription
+ + +## Example +```sql +SELECT +region, +distribution_id, +monitoring_subscription +FROM awscc.cloudfront.monitoring_subscription +WHERE data__Identifier = '<DistributionId>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscriptions/index.md b/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscriptions/index.md new file mode 100644 index 0000000000..9722f39c9b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscriptions/index.md @@ -0,0 +1,54 @@ +--- +title: monitoring_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_subscriptions + - 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 +--- +Retrieves a list of monitoring_subscriptions in a region + +## Overview + + + + + +
Namemonitoring_subscriptions
TypeResource
Descriptionmonitoring_subscriptions
Idawscc.cloudfront.monitoring_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
distribution_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the monitoring_subscriptions resource, the following permissions are required: + +### Create +
+cloudfront:CreateMonitoringSubscription
+ + +## Example +```sql +SELECT +region, +distribution_id +FROM awscc.cloudfront.monitoring_subscriptions + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/origin_access_control/index.md b/docs/awscc-docs/providers/awscc/cloudfront/origin_access_control/index.md new file mode 100644 index 0000000000..b4dabcfa90 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/origin_access_control/index.md @@ -0,0 +1,66 @@ +--- +title: origin_access_control +hide_title: false +hide_table_of_contents: false +keywords: + - origin_access_control + - 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 +--- +Gets an individual origin_access_control resource + +## Overview + + + + + +
Nameorigin_access_control
TypeResource
Descriptionorigin_access_control
Idawscc.cloudfront.origin_access_control
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
origin_access_control_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_access_control resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteOriginAccessControl,
+cloudfront:GetOriginAccessControl
+ +### Read +
+cloudfront:GetOriginAccessControl
+ +### Update +
+cloudfront:UpdateOriginAccessControl,
+cloudfront:GetOriginAccessControl
+ + +## Example +```sql +SELECT +region, +id, +origin_access_control_config +FROM awscc.cloudfront.origin_access_control +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/origin_access_controls/index.md b/docs/awscc-docs/providers/awscc/cloudfront/origin_access_controls/index.md new file mode 100644 index 0000000000..954532d748 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/origin_access_controls/index.md @@ -0,0 +1,58 @@ +--- +title: origin_access_controls +hide_title: false +hide_table_of_contents: false +keywords: + - origin_access_controls + - 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 +--- +Retrieves a list of origin_access_controls in a region + +## Overview + + + + + +
Nameorigin_access_controls
TypeResource
Descriptionorigin_access_controls
Idawscc.cloudfront.origin_access_controls
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_access_controls resource, the following permissions are required: + +### Create +
+cloudfront:CreateOriginAccessControl
+ +### List +
+cloudfront:ListOriginAccessControls
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.origin_access_controls + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policies/index.md b/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policies/index.md new file mode 100644 index 0000000000..d27c9d3c91 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policies/index.md @@ -0,0 +1,58 @@ +--- +title: origin_request_policies +hide_title: false +hide_table_of_contents: false +keywords: + - origin_request_policies + - 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 +--- +Retrieves a list of origin_request_policies in a region + +## Overview + + + + + +
Nameorigin_request_policies
TypeResource
Descriptionorigin_request_policies
Idawscc.cloudfront.origin_request_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_request_policies resource, the following permissions are required: + +### Create +
+cloudfront:CreateOriginRequestPolicy
+ +### List +
+cloudfront:ListOriginRequestPolicies
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.origin_request_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policy/index.md b/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policy/index.md new file mode 100644 index 0000000000..b564b09ed8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policy/index.md @@ -0,0 +1,68 @@ +--- +title: origin_request_policy +hide_title: false +hide_table_of_contents: false +keywords: + - origin_request_policy + - 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 +--- +Gets an individual origin_request_policy resource + +## Overview + + + + + +
Nameorigin_request_policy
TypeResource
Descriptionorigin_request_policy
Idawscc.cloudfront.origin_request_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
last_modified_timestring
origin_request_policy_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_request_policy resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteOriginRequestPolicy,
+cloudfront:GetOriginRequestPolicy
+ +### Read +
+cloudfront:GetOriginRequestPolicy
+ +### Update +
+cloudfront:UpdateOriginRequestPolicy,
+cloudfront:GetOriginRequestPolicy
+ + +## Example +```sql +SELECT +region, +id, +last_modified_time, +origin_request_policy_config +FROM awscc.cloudfront.origin_request_policy +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md b/docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md new file mode 100644 index 0000000000..9f54968026 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md @@ -0,0 +1,68 @@ +--- +title: public_key +hide_title: false +hide_table_of_contents: false +keywords: + - public_key + - 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 +--- +Gets an individual public_key resource + +## Overview + + + + + +
Namepublic_key
TypeResource
Descriptionpublic_key
Idawscc.cloudfront.public_key
+ +## Fields + + + + + + + +
NameDatatypeDescription
created_timestring
idstring
public_key_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the public_key resource, the following permissions are required: + +### Delete +
+cloudfront:DeletePublicKey,
+cloudfront:GetPublicKey
+ +### Read +
+cloudfront:GetPublicKey
+ +### Update +
+cloudfront:UpdatePublicKey,
+cloudfront:GetPublicKey
+ + +## Example +```sql +SELECT +region, +created_time, +id, +public_key_config +FROM awscc.cloudfront.public_key +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md b/docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md new file mode 100644 index 0000000000..6634b41b1a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md @@ -0,0 +1,58 @@ +--- +title: public_keys +hide_title: false +hide_table_of_contents: false +keywords: + - public_keys + - 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 +--- +Retrieves a list of public_keys in a region + +## Overview + + + + + +
Namepublic_keys
TypeResource
Descriptionpublic_keys
Idawscc.cloudfront.public_keys
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the public_keys resource, the following permissions are required: + +### Create +
+cloudfront:CreatePublicKey
+ +### List +
+cloudfront:ListPublicKeys
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.public_keys + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_config/index.md b/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_config/index.md new file mode 100644 index 0000000000..ac5d10f61b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_config/index.md @@ -0,0 +1,73 @@ +--- +title: realtime_log_config +hide_title: false +hide_table_of_contents: false +keywords: + - realtime_log_config + - 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 +--- +Gets an individual realtime_log_config resource + +## Overview + + + + + +
Namerealtime_log_config
TypeResource
Descriptionrealtime_log_config
Idawscc.cloudfront.realtime_log_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
end_pointsarray
fieldsarray
namestring
sampling_ratenumber
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the realtime_log_config resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteRealtimeLogConfig,
+cloudfront:GetRealtimeLogConfig
+ +### Read +
+cloudfront:GetRealtimeLogConfig
+ +### Update +
+cloudfront:UpdateRealtimeLogConfig,
+cloudfront:GetRealtimeLogConfig,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +arn, +end_points, +fields, +name, +sampling_rate +FROM awscc.cloudfront.realtime_log_config +WHERE data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_configs/index.md b/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_configs/index.md new file mode 100644 index 0000000000..1cac19876f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_configs/index.md @@ -0,0 +1,59 @@ +--- +title: realtime_log_configs +hide_title: false +hide_table_of_contents: false +keywords: + - realtime_log_configs + - 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 +--- +Retrieves a list of realtime_log_configs in a region + +## Overview + + + + + +
Namerealtime_log_configs
TypeResource
Descriptionrealtime_log_configs
Idawscc.cloudfront.realtime_log_configs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the realtime_log_configs resource, the following permissions are required: + +### Create +
+cloudfront:CreateRealtimeLogConfig,
+iam:PassRole
+ +### List +
+cloudfront:ListRealtimeLogConfigs
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.cloudfront.realtime_log_configs + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policies/index.md b/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policies/index.md new file mode 100644 index 0000000000..73b983e353 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policies/index.md @@ -0,0 +1,58 @@ +--- +title: response_headers_policies +hide_title: false +hide_table_of_contents: false +keywords: + - response_headers_policies + - 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 +--- +Retrieves a list of response_headers_policies in a region + +## Overview + + + + + +
Nameresponse_headers_policies
TypeResource
Descriptionresponse_headers_policies
Idawscc.cloudfront.response_headers_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the response_headers_policies resource, the following permissions are required: + +### Create +
+cloudfront:CreateResponseHeadersPolicy
+ +### List +
+cloudfront:ListResponseHeadersPolicies
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cloudfront.response_headers_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policy/index.md b/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policy/index.md new file mode 100644 index 0000000000..d2035c1787 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policy/index.md @@ -0,0 +1,68 @@ +--- +title: response_headers_policy +hide_title: false +hide_table_of_contents: false +keywords: + - response_headers_policy + - 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 +--- +Gets an individual response_headers_policy resource + +## Overview + + + + + +
Nameresponse_headers_policy
TypeResource
Descriptionresponse_headers_policy
Idawscc.cloudfront.response_headers_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
last_modified_timestring
response_headers_policy_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the response_headers_policy resource, the following permissions are required: + +### Delete +
+cloudfront:DeleteResponseHeadersPolicy,
+cloudfront:GetResponseHeadersPolicy
+ +### Read +
+cloudfront:GetResponseHeadersPolicy
+ +### Update +
+cloudfront:UpdateResponseHeadersPolicy,
+cloudfront:GetResponseHeadersPolicy
+ + +## Example +```sql +SELECT +region, +id, +last_modified_time, +response_headers_policy_config +FROM awscc.cloudfront.response_headers_policy +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md new file mode 100644 index 0000000000..69a1f8fea6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md @@ -0,0 +1,75 @@ +--- +title: channel +hide_title: false +hide_table_of_contents: false +keywords: + - channel + - 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 +--- +Gets an individual channel resource + +## Overview + + + + + +
Namechannel
TypeResource
Descriptionchannel
Idawscc.cloudtrail.channel
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestring
sourcestringThe ARN of an on-premises storage solution or application, or a partner event source.
destinationsarrayOne or more resources to which events arriving through a channel are logged and stored.
channel_arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +
+CloudTrail:GetChannel,
+CloudTrail:ListChannels
+ +### Update +
+CloudTrail:UpdateChannel,
+CloudTrail:GetChannel,
+CloudTrail:AddTags,
+CloudTrail:RemoveTags
+ +### Delete +
+CloudTrail:DeleteChannel
+ + +## Example +```sql +SELECT +region, +name, +source, +destinations, +channel_arn, +tags +FROM awscc.cloudtrail.channel +WHERE region = 'us-east-1' +AND data__Identifier = '<ChannelArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md new file mode 100644 index 0000000000..d222ee2f74 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md @@ -0,0 +1,59 @@ +--- +title: channels +hide_title: false +hide_table_of_contents: false +keywords: + - channels + - 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 +--- +Retrieves a list of channels in a region + +## Overview + + + + + +
Namechannels
TypeResource
Descriptionchannels
Idawscc.cloudtrail.channels
+ +## Fields + + + + + +
NameDatatypeDescription
channel_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +
+CloudTrail:CreateChannel,
+CloudTrail:AddTags
+ +### List +
+CloudTrail:ListChannels
+ + +## Example +```sql +SELECT +region, +channel_arn +FROM awscc.cloudtrail.channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/event_data_store/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/event_data_store/index.md new file mode 100644 index 0000000000..2fcaee9ef7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/event_data_store/index.md @@ -0,0 +1,126 @@ +--- +title: event_data_store +hide_title: false +hide_table_of_contents: false +keywords: + - event_data_store + - 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 +--- +Gets an individual event_data_store resource + +## Overview + + + + + +
Nameevent_data_store
TypeResource
Descriptionevent_data_store
Idawscc.cloudtrail.event_data_store
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
advanced_event_selectorsarrayThe advanced event selectors that were used to select events for the data store.
created_timestampstringThe timestamp of the event data store's creation.
event_data_store_arnstringThe ARN of the event data store.
federation_enabledbooleanIndicates whether federation is enabled on an event data store.
federation_role_arnstringThe ARN of the role used for event data store federation.
multi_region_enabledbooleanIndicates whether the event data store includes events from all regions, or only from the region in which it was created.
namestringThe name of the event data store.
organization_enabledbooleanIndicates that an event data store is collecting logged events for an organization.
billing_modestringThe mode that the event data store will use to charge for event storage.
retention_periodintegerThe retention period, in days.
statusstringThe status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
termination_protection_enabledbooleanIndicates whether the event data store is protected from termination.
updated_timestampstringThe 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.
kms_key_idstringSpecifies 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.
tagsarray
insight_selectorsarrayLets 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.
insights_destinationstringSpecifies 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
ingestion_enabledbooleanIndicates whether the event data store is ingesting events.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_data_store resource, the following permissions are required: + +### Read +
+CloudTrail:GetEventDataStore,
+CloudTrail:ListEventDataStores,
+CloudTrail:GetInsightSelectors,
+CloudTrail:ListTags
+ +### Update +
+CloudTrail:UpdateEventDataStore,
+CloudTrail:RestoreEventDataStore,
+CloudTrail:AddTags,
+CloudTrail:RemoveTags,
+CloudTrail:StartEventDataStoreIngestion,
+CloudTrail:StopEventDataStoreIngestion,
+CloudTrail:GetEventDataStore,
+CloudTrail:PutInsightSelectors,
+CloudTrail:GetInsightSelectors,
+CloudTrail:EnableFederation,
+CloudTrail:DisableFederation,
+iam:PassRole,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+organizations:DescribeOrganization,
+organizations:ListAWSServiceAccessForOrganization,
+glue:CreateDatabase,
+glue:CreateTable,
+glue:PassConnection,
+lakeformation:RegisterResource,
+glue:DeleteTable,
+lakeformation:DeregisterResource,
+kms:DescribeKey
+ +### Delete +
+CloudTrail:DeleteEventDataStore,
+CloudTrail:GetEventDataStore,
+CloudTrail:DisableFederation,
+glue:DeleteTable,
+lakeformation:DeregisterResource
+ + +## Example +```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, +tags, +insight_selectors, +insights_destination, +ingestion_enabled +FROM awscc.cloudtrail.event_data_store +WHERE region = 'us-east-1' +AND data__Identifier = '<EventDataStoreArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/event_data_stores/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/event_data_stores/index.md new file mode 100644 index 0000000000..3c79f2104b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/event_data_stores/index.md @@ -0,0 +1,76 @@ +--- +title: event_data_stores +hide_title: false +hide_table_of_contents: false +keywords: + - event_data_stores + - 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 +--- +Retrieves a list of event_data_stores in a region + +## Overview + + + + + +
Nameevent_data_stores
TypeResource
Descriptionevent_data_stores
Idawscc.cloudtrail.event_data_stores
+ +## Fields + + + + + +
NameDatatypeDescription
event_data_store_arnstringThe ARN of the event data store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_data_stores resource, the following permissions are required: + +### Create +
+CloudTrail:CreateEventDataStore,
+CloudTrail:AddTags,
+CloudTrail:PutInsightSelectors,
+CloudTrail:EnableFederation,
+CloudTrail:GetEventDataStore,
+iam:PassRole,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+organizations:DescribeOrganization,
+organizations:ListAWSServiceAccessForOrganization,
+kms:GenerateDataKey,
+kms:Decrypt,
+glue:CreateDatabase,
+glue:CreateTable,
+glue:PassConnection,
+lakeformation:RegisterResource
+ +### List +
+CloudTrail:ListEventDataStores,
+CloudTrail:GetEventDataStore,
+CloudTrail:GetInsightSelectors,
+CloudTrail:ListTags
+ + +## Example +```sql +SELECT +region, +event_data_store_arn +FROM awscc.cloudtrail.event_data_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/index.md new file mode 100644 index 0000000000..00f34455e4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/index.md @@ -0,0 +1,45 @@ +--- +title: cloudtrail +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cloudtrail service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+channel
+channels
+event_data_store
+event_data_stores +
+
+resource_policies
+resource_policy
+trail
+trails +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/resource_policies/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/resource_policies/index.md new file mode 100644 index 0000000000..0d1d1cb2cf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/resource_policies/index.md @@ -0,0 +1,55 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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 +--- +Retrieves a list of resource_policies in a region + +## Overview + + + + + +
Nameresource_policies
TypeResource
Descriptionresource_policies
Idawscc.cloudtrail.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
resource_arnstringThe ARN of the AWS CloudTrail resource to which the policy applies.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +
+CloudTrail:PutResourcePolicy,
+CloudTrail:GetResourcePolicy
+ + +## Example +```sql +SELECT +region, +resource_arn +FROM awscc.cloudtrail.resource_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md new file mode 100644 index 0000000000..7b083fbbd3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md @@ -0,0 +1,66 @@ +--- +title: resource_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy + - 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 +--- +Gets an individual resource_policy resource + +## Overview + + + + + +
Nameresource_policy
TypeResource
Descriptionresource_policy
Idawscc.cloudtrail.resource_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_arnstringThe ARN of the AWS CloudTrail resource to which the policy applies.
resource_policyobjectA policy document containing permissions to add to the specified resource. 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +
+CloudTrail:GetResourcePolicy
+ +### Update +
+CloudTrail:PutResourcePolicy,
+CloudTrail:GetResourcePolicy
+ +### Delete +
+CloudTrail:DeleteResourcePolicy
+ + +## Example +```sql +SELECT +region, +resource_arn, +resource_policy +FROM awscc.cloudtrail.resource_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md new file mode 100644 index 0000000000..c4147c1c69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md @@ -0,0 +1,115 @@ +--- +title: trail +hide_title: false +hide_table_of_contents: false +keywords: + - trail + - 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 +--- +Gets an individual trail resource + +## Overview + + + + + +
Nametrail
TypeResource
Descriptiontrail
Idawscc.cloudtrail.trail
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cloud_watch_logs_log_group_arnstringSpecifies 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.
cloud_watch_logs_role_arnstringSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
enable_log_file_validationbooleanSpecifies whether log file validation is enabled. The default is false.
advanced_event_selectorsarrayThe advanced event selectors that were used to select events for the data store.
event_selectorsarrayUse 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.
include_global_service_eventsbooleanSpecifies whether the trail is publishing events from global services such as IAM to the log files.
is_loggingbooleanWhether the CloudTrail is currently logging AWS API calls.
is_multi_region_trailbooleanSpecifies 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.
is_organization_trailbooleanSpecifies 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.
k_ms_key_idstringSpecifies 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.
s3_bucket_namestringSpecifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
s3_key_prefixstringSpecifies 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.
sns_topic_namestringSpecifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tagsarray
trail_namestring
arnstring
sns_topic_arnstring
insight_selectorsarrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trail resource, the following permissions are required: + +### Read +
+CloudTrail:GetTrail,
+CloudTrail:GetTrailStatus,
+CloudTrail:ListTags,
+CloudTrail:GetEventSelectors,
+CloudTrail:GetInsightSelectors,
+CloudTrail:DescribeTrails
+ +### Update +
+CloudTrail:UpdateTrail,
+CloudTrail:StartLogging,
+CloudTrail:StopLogging,
+CloudTrail:AddTags,
+CloudTrail:RemoveTags,
+CloudTrail:PutEventSelectors,
+CloudTrail:PutInsightSelectors,
+iam:GetRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+organizations:DescribeOrganization,
+organizations:ListAWSServiceAccessForOrganization,
+CloudTrail:GetTrail,
+CloudTrail:DescribeTrails
+ +### Delete +
+CloudTrail:DeleteTrail
+ + +## Example +```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, +k_ms_key_id, +s3_bucket_name, +s3_key_prefix, +sns_topic_name, +tags, +trail_name, +arn, +sns_topic_arn, +insight_selectors +FROM awscc.cloudtrail.trail +WHERE region = 'us-east-1' +AND data__Identifier = '<TrailName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md new file mode 100644 index 0000000000..c11e9b0372 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md @@ -0,0 +1,73 @@ +--- +title: trails +hide_title: false +hide_table_of_contents: false +keywords: + - trails + - 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 +--- +Retrieves a list of trails in a region + +## Overview + + + + + +
Nametrails
TypeResource
Descriptiontrails
Idawscc.cloudtrail.trails
+ +## Fields + + + + + +
NameDatatypeDescription
trail_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trails resource, the following permissions are required: + +### Create +
+CloudTrail:CreateTrail,
+CloudTrail:StartLogging,
+CloudTrail:AddTags,
+CloudTrail:PutEventSelectors,
+CloudTrail:PutInsightSelectors,
+iam:GetRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+organizations:DescribeOrganization,
+organizations:ListAWSServiceAccessForOrganization
+ +### List +
+CloudTrail:ListTrails,
+CloudTrail:GetTrail,
+CloudTrail:GetTrailStatus,
+CloudTrail:ListTags,
+CloudTrail:GetEventSelectors,
+CloudTrail:GetInsightSelectors,
+CloudTrail:DescribeTrails
+ + +## Example +```sql +SELECT +region, +trail_name +FROM awscc.cloudtrail.trails +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md new file mode 100644 index 0000000000..7486dca985 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md @@ -0,0 +1,107 @@ +--- +title: alarm +hide_title: false +hide_table_of_contents: false +keywords: + - alarm + - 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 +--- +Gets an individual alarm resource + +## Overview + + + + + +
Namealarm
TypeResource
Descriptionalarm
Idawscc.cloudwatch.alarm
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
threshold_metric_idstringIn 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.
evaluate_low_sample_count_percentilestringUsed only for alarms based on percentiles.
extended_statisticstringThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
comparison_operatorstringThe arithmetic operation to use when comparing the specified statistic and threshold.
treat_missing_datastringSets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
dimensionsarrayThe 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.
periodintegerThe period in seconds, over which the statistic is applied.
evaluation_periodsintegerThe number of periods over which data is compared to the specified threshold.
unitstringThe unit of the metric associated with the alarm.
namespacestringThe namespace of the metric associated with the alarm.
o_kactionsarrayThe actions to execute when this alarm transitions to the OK state from any other state.
alarm_actionsarrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state.
metric_namestringThe name of the metric associated with the alarm.
actions_enabledbooleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
metricsarrayAn array that enables you to create an alarm based on the result of a metric math expression.
alarm_descriptionstringThe description of the alarm.
alarm_namestringThe name of the alarm.
statisticstringThe statistic for the metric associated with the alarm, other than percentile.
insufficient_data_actionsarrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
arnstringAmazon Resource Name is a unique name for each resource.
datapoints_to_alarmintegerThe number of datapoints that must be breaching to trigger the alarm.
thresholdnumberIn 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alarm resource, the following permissions are required: + +### Update +
+cloudwatch:PutMetricAlarm,
+cloudwatch:DescribeAlarms
+ +### Delete +
+cloudwatch:DeleteAlarms,
+cloudwatch:DescribeAlarms
+ +### Read +
+cloudwatch:DescribeAlarms
+ + +## Example +```sql +SELECT +region, +threshold_metric_id, +evaluate_low_sample_count_percentile, +extended_statistic, +comparison_operator, +treat_missing_data, +dimensions, +period, +evaluation_periods, +unit, +namespace, +o_kactions, +alarm_actions, +metric_name, +actions_enabled, +metrics, +alarm_description, +alarm_name, +statistic, +insufficient_data_actions, +arn, +datapoints_to_alarm, +threshold +FROM awscc.cloudwatch.alarm +WHERE region = 'us-east-1' +AND data__Identifier = '<AlarmName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md new file mode 100644 index 0000000000..fd98f96e48 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md @@ -0,0 +1,59 @@ +--- +title: alarms +hide_title: false +hide_table_of_contents: false +keywords: + - alarms + - 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 +--- +Retrieves a list of alarms in a region + +## Overview + + + + + +
Namealarms
TypeResource
Descriptionalarms
Idawscc.cloudwatch.alarms
+ +## Fields + + + + + +
NameDatatypeDescription
alarm_namestringThe name of the alarm.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alarms resource, the following permissions are required: + +### Create +
+cloudwatch:PutMetricAlarm,
+cloudwatch:DescribeAlarms
+ +### List +
+cloudwatch:DescribeAlarms
+ + +## Example +```sql +SELECT +region, +alarm_name +FROM awscc.cloudwatch.alarms +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md new file mode 100644 index 0000000000..2f6ad2fe15 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md @@ -0,0 +1,85 @@ +--- +title: composite_alarm +hide_title: false +hide_table_of_contents: false +keywords: + - composite_alarm + - 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 +--- +Gets an individual composite_alarm resource + +## Overview + + + + + +
Namecomposite_alarm
TypeResource
Descriptioncomposite_alarm
Idawscc.cloudwatch.composite_alarm
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the alarm
alarm_namestringThe name of the Composite Alarm
alarm_rulestringExpression which aggregates the state of other Alarms (Metric or Composite Alarms)
alarm_descriptionstringThe description of the alarm
actions_enabledbooleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
o_kactionsarrayThe 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).
alarm_actionsarrayThe 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).
insufficient_data_actionsarrayThe 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).
actions_suppressorstringActions 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.
actions_suppressor_wait_periodintegerActions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
actions_suppressor_extension_periodintegerActions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the composite_alarm resource, the following permissions are required: + +### Read +
+cloudwatch:DescribeAlarms
+ +### Update +
+cloudwatch:DescribeAlarms,
+cloudwatch:PutCompositeAlarm
+ +### Delete +
+cloudwatch:DescribeAlarms,
+cloudwatch:DeleteAlarms
+ + +## Example +```sql +SELECT +region, +arn, +alarm_name, +alarm_rule, +alarm_description, +actions_enabled, +o_kactions, +alarm_actions, +insufficient_data_actions, +actions_suppressor, +actions_suppressor_wait_period, +actions_suppressor_extension_period +FROM awscc.cloudwatch.composite_alarm +WHERE region = 'us-east-1' +AND data__Identifier = '<AlarmName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md new file mode 100644 index 0000000000..ec256508f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md @@ -0,0 +1,59 @@ +--- +title: composite_alarms +hide_title: false +hide_table_of_contents: false +keywords: + - composite_alarms + - 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 +--- +Retrieves a list of composite_alarms in a region + +## Overview + + + + + +
Namecomposite_alarms
TypeResource
Descriptioncomposite_alarms
Idawscc.cloudwatch.composite_alarms
+ +## Fields + + + + + +
NameDatatypeDescription
alarm_namestringThe name of the Composite Alarm
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the composite_alarms resource, the following permissions are required: + +### Create +
+cloudwatch:DescribeAlarms,
+cloudwatch:PutCompositeAlarm
+ +### List +
+cloudwatch:DescribeAlarms
+ + +## Example +```sql +SELECT +region, +alarm_name +FROM awscc.cloudwatch.composite_alarms +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/index.md new file mode 100644 index 0000000000..8948529e54 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudwatch/index.md @@ -0,0 +1,43 @@ +--- +title: cloudwatch +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cloudwatch service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+alarm
+alarms
+composite_alarm +
+
+composite_alarms
+metric_stream
+metric_streams +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/metric_stream/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/metric_stream/index.md new file mode 100644 index 0000000000..123868874d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudwatch/metric_stream/index.md @@ -0,0 +1,92 @@ +--- +title: metric_stream +hide_title: false +hide_table_of_contents: false +keywords: + - metric_stream + - 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 +--- +Gets an individual metric_stream resource + +## Overview + + + + + +
Namemetric_stream
TypeResource
Descriptionmetric_stream
Idawscc.cloudwatch.metric_stream
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name of the metric stream.
creation_datestringThe date of creation of the metric stream.
exclude_filtersarrayDefine 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.
firehose_arnstringThe ARN of the Kinesis Firehose where to stream the data.
include_filtersarrayDefine 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.
last_update_datestringThe date of the last update of the metric stream.
namestringName of the metric stream.
role_arnstringThe ARN of the role that provides access to the Kinesis Firehose.
statestringDisplays the state of the Metric Stream.
output_formatstringThe output format of the data streamed to the Kinesis Firehose.
statistics_configurationsarrayBy 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.
tagsarrayA set of tags to assign to the delivery stream.
include_linked_accounts_metricsbooleanIf 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the metric_stream resource, the following permissions are required: + +### Update +
+cloudwatch:PutMetricStream,
+cloudwatch:GetMetricStream,
+cloudwatch:TagResource,
+cloudwatch:UntagResource,
+iam:PassRole
+ +### Delete +
+cloudwatch:DeleteMetricStream,
+cloudwatch:GetMetricStream
+ +### Read +
+cloudwatch:GetMetricStream
+ + +## Example +```sql +SELECT +region, +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 awscc.cloudwatch.metric_stream +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md new file mode 100644 index 0000000000..81b0f13a76 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md @@ -0,0 +1,61 @@ +--- +title: metric_streams +hide_title: false +hide_table_of_contents: false +keywords: + - metric_streams + - 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 +--- +Retrieves a list of metric_streams in a region + +## Overview + + + + + +
Namemetric_streams
TypeResource
Descriptionmetric_streams
Idawscc.cloudwatch.metric_streams
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the metric stream.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the metric_streams resource, the following permissions are required: + +### Create +
+cloudwatch:PutMetricStream,
+cloudwatch:GetMetricStream,
+cloudwatch:TagResource,
+iam:PassRole
+ +### List +
+cloudwatch:ListMetricStreams
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.cloudwatch.metric_streams +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codeartifact/domain/index.md b/docs/awscc-docs/providers/awscc/codeartifact/domain/index.md new file mode 100644 index 0000000000..93b13f36a0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeartifact/domain/index.md @@ -0,0 +1,82 @@ +--- +title: domain +hide_title: false +hide_table_of_contents: false +keywords: + - domain + - 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 +--- +Gets an individual domain resource + +## Overview + + + + + +
Namedomain
TypeResource
Descriptiondomain
Idawscc.codeartifact.domain
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe name of the domain.
namestringThe name of the domain. This field is used for GetAtt
ownerstringThe 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt
encryption_keystringThe ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
permissions_policy_documentobjectThe access control resource policy on the provided domain.
tagsarrayAn array of key-value pairs to apply to this resource.
arnstringThe ARN of the domain.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +
+codeartifact:DescribeDomain,
+codeartifact:GetDomainPermissionsPolicy,
+codeartifact:ListTagsForResource
+ +### Update +
+codeartifact:PutDomainPermissionsPolicy,
+codeartifact:DeleteDomainPermissionsPolicy,
+codeartifact:GetDomainPermissionsPolicy,
+codeartifact:TagResource,
+codeartifact:UntagResource
+ +### Delete +
+codeartifact:DeleteDomain,
+codeartifact:DescribeDomain
+ + +## Example +```sql +SELECT +region, +domain_name, +name, +owner, +encryption_key, +permissions_policy_document, +tags, +arn +FROM awscc.codeartifact.domain +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/codeartifact/domains/index.md b/docs/awscc-docs/providers/awscc/codeartifact/domains/index.md new file mode 100644 index 0000000000..d6c5564c9c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeartifact/domains/index.md @@ -0,0 +1,62 @@ +--- +title: domains +hide_title: false +hide_table_of_contents: false +keywords: + - domains + - 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 +--- +Retrieves a list of domains in a region + +## Overview + + + + + +
Namedomains
TypeResource
Descriptiondomains
Idawscc.codeartifact.domains
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the domain.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +
+codeartifact:CreateDomain,
+codeartifact:DescribeDomain,
+codeartifact:PutDomainPermissionsPolicy,
+codeartifact:GetDomainPermissionsPolicy,
+codeartifact:TagResource
+ +### List +
+codeartifact:ListDomains
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.codeartifact.domains +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codeartifact/index.md b/docs/awscc-docs/providers/awscc/codeartifact/index.md new file mode 100644 index 0000000000..1d0259132d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeartifact/index.md @@ -0,0 +1,41 @@ +--- +title: codeartifact +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codeartifact service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+domain
+domains +
+
+repositories
+repository +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codeartifact/repositories/index.md b/docs/awscc-docs/providers/awscc/codeartifact/repositories/index.md new file mode 100644 index 0000000000..23f246bf5c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeartifact/repositories/index.md @@ -0,0 +1,63 @@ +--- +title: repositories +hide_title: false +hide_table_of_contents: false +keywords: + - repositories + - 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 +--- +Retrieves a list of repositories in a region + +## Overview + + + + + +
Namerepositories
TypeResource
Descriptionrepositories
Idawscc.codeartifact.repositories
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the repository.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repositories resource, the following permissions are required: + +### Create +
+codeartifact:CreateRepository,
+codeartifact:DescribeRepository,
+codeartifact:PutRepositoryPermissionsPolicy,
+codeartifact:AssociateExternalConnection,
+codeartifact:AssociateWithDownstreamRepository,
+codeartifact:TagResource
+ +### List +
+codeartifact:ListRepositories
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.codeartifact.repositories +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codeartifact/repository/index.md b/docs/awscc-docs/providers/awscc/codeartifact/repository/index.md new file mode 100644 index 0000000000..4c7cee4c05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeartifact/repository/index.md @@ -0,0 +1,92 @@ +--- +title: repository +hide_title: false +hide_table_of_contents: false +keywords: + - repository + - 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 +--- +Gets an individual repository resource + +## Overview + + + + + +
Namerepository
TypeResource
Descriptionrepository
Idawscc.codeartifact.repository
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
repository_namestringThe name of the repository.
namestringThe name of the repository. This is used for GetAtt
domain_namestringThe name of the domain that contains the repository.
domain_ownerstringThe 12-digit account ID of the AWS account that owns the domain.
descriptionstringA text description of the repository.
arnstringThe ARN of the repository.
external_connectionsarrayA list of external connections associated with the repository.
upstreamsarrayA list of upstream repositories associated with the repository.
permissions_policy_documentobjectThe access control resource policy on the provided repository.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repository resource, the following permissions are required: + +### Read +
+codeartifact:DescribeRepository,
+codeartifact:GetRepositoryPermissionsPolicy,
+codeartifact:ListTagsForResource
+ +### Update +
+codeartifact:PutRepositoryPermissionsPolicy,
+codeartifact:DeleteRepositoryPermissionsPolicy,
+codeartifact:AssociateExternalConnection,
+codeartifact:DisassociateExternalConnection,
+codeartifact:UpdateRepository,
+codeartifact:DescribeRepository,
+codeartifact:AssociateWithDownstreamRepository,
+codeartifact:TagResource,
+codeartifact:UntagResource
+ +### Delete +
+codeartifact:DeleteRepository,
+codeartifact:DescribeRepository
+ + +## Example +```sql +SELECT +region, +repository_name, +name, +domain_name, +domain_owner, +description, +arn, +external_connections, +upstreams, +permissions_policy_document, +tags +FROM awscc.codeartifact.repository +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/codebuild/fleet/index.md b/docs/awscc-docs/providers/awscc/codebuild/fleet/index.md new file mode 100644 index 0000000000..000ba7c1ad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codebuild/fleet/index.md @@ -0,0 +1,75 @@ +--- +title: fleet +hide_title: false +hide_table_of_contents: false +keywords: + - fleet + - 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 +--- +Gets an individual fleet resource + +## Overview + + + + + +
Namefleet
TypeResource
Descriptionfleet
Idawscc.codebuild.fleet
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestring
base_capacityinteger
environment_typestring
compute_typestring
tagsarray
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Delete +
+codebuild:BatchGetFleets,
+codebuild:DeleteFleet
+ +### Read +
+codebuild:BatchGetFleets
+ +### Update +
+codebuild:BatchGetFleets,
+codebuild:UpdateFleet
+ + +## Example +```sql +SELECT +region, +name, +base_capacity, +environment_type, +compute_type, +tags, +arn +FROM awscc.codebuild.fleet +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/codebuild/fleets/index.md b/docs/awscc-docs/providers/awscc/codebuild/fleets/index.md new file mode 100644 index 0000000000..0b11d33728 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codebuild/fleets/index.md @@ -0,0 +1,59 @@ +--- +title: fleets +hide_title: false +hide_table_of_contents: false +keywords: + - fleets + - 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 +--- +Retrieves a list of fleets in a region + +## Overview + + + + + +
Namefleets
TypeResource
Descriptionfleets
Idawscc.codebuild.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +
+codebuild:BatchGetFleets,
+codebuild:CreateFleet
+ +### List +
+codebuild:ListFleets
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.codebuild.fleets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codebuild/index.md b/docs/awscc-docs/providers/awscc/codebuild/index.md new file mode 100644 index 0000000000..685574c9ad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codebuild/index.md @@ -0,0 +1,39 @@ +--- +title: codebuild +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codebuild service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+fleet +
+
+fleets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codedeploy/application/index.md b/docs/awscc-docs/providers/awscc/codedeploy/application/index.md new file mode 100644 index 0000000000..5b430868f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codedeploy/application/index.md @@ -0,0 +1,70 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.codedeploy.application
+ +## Fields + + + + + + + +
NameDatatypeDescription
application_namestringA 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.
compute_platformstringThe compute platform that CodeDeploy deploys the application to.
tagsarrayThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+codedeploy:GetApplication,
+codedeploy:ListTagsForResource
+ +### Delete +
+codedeploy:GetApplication,
+codedeploy:DeleteApplication
+ +### Update +
+codedeploy:TagResource,
+codedeploy:UntagResource
+ + +## Example +```sql +SELECT +region, +application_name, +compute_platform, +tags +FROM awscc.codedeploy.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/codedeploy/applications/index.md b/docs/awscc-docs/providers/awscc/codedeploy/applications/index.md new file mode 100644 index 0000000000..ab0ef71f9e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codedeploy/applications/index.md @@ -0,0 +1,59 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.codedeploy.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_namestringA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+codedeploy:CreateApplication,
+codedeploy:TagResource
+ +### List +
+codedeploy:ListApplications
+ + +## Example +```sql +SELECT +region, +application_name +FROM awscc.codedeploy.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md b/docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md new file mode 100644 index 0000000000..d5ad5657c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md @@ -0,0 +1,68 @@ +--- +title: deployment_config +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_config + - 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 +--- +Gets an individual deployment_config resource + +## Overview + + + + + +
Namedeployment_config
TypeResource
Descriptiondeployment_config
Idawscc.codedeploy.deployment_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
compute_platformstringThe destination platform type for the deployment (Lambda, Server, or ECS).
deployment_config_namestringA 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.
minimum_healthy_hostsobjectThe 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.
zonal_configobjectThe zonal deployment config that specifies how the zonal deployment behaves
traffic_routing_configobjectThe configuration that specifies how the deployment traffic is routed.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployment_config resource, the following permissions are required: + +### Read +
+codedeploy:GetDeploymentConfig
+ +### Delete +
+codedeploy:GetDeploymentConfig,
+codedeploy:DeleteDeploymentConfig
+ + +## Example +```sql +SELECT +region, +compute_platform, +deployment_config_name, +minimum_healthy_hosts, +zonal_config, +traffic_routing_config +FROM awscc.codedeploy.deployment_config +WHERE region = 'us-east-1' +AND data__Identifier = '<DeploymentConfigName>' +``` diff --git a/docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md b/docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md new file mode 100644 index 0000000000..6a4ba5e201 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md @@ -0,0 +1,58 @@ +--- +title: deployment_configs +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_configs + - 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 +--- +Retrieves a list of deployment_configs in a region + +## Overview + + + + + +
Namedeployment_configs
TypeResource
Descriptiondeployment_configs
Idawscc.codedeploy.deployment_configs
+ +## Fields + + + + + +
NameDatatypeDescription
deployment_config_namestringA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployment_configs resource, the following permissions are required: + +### Create +
+codedeploy:CreateDeploymentConfig
+ +### List +
+codedeploy:ListDeploymentConfigs
+ + +## Example +```sql +SELECT +region, +deployment_config_name +FROM awscc.codedeploy.deployment_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codedeploy/index.md b/docs/awscc-docs/providers/awscc/codedeploy/index.md new file mode 100644 index 0000000000..f46ec3c85d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codedeploy/index.md @@ -0,0 +1,41 @@ +--- +title: codedeploy +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codedeploy service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+application
+applications +
+
+deployment_config
+deployment_configs +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codeguruprofiler/index.md b/docs/awscc-docs/providers/awscc/codeguruprofiler/index.md new file mode 100644 index 0000000000..5fd0c10a34 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeguruprofiler/index.md @@ -0,0 +1,39 @@ +--- +title: codeguruprofiler +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codeguruprofiler service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+profiling_group +
+
+profiling_groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_group/index.md b/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_group/index.md new file mode 100644 index 0000000000..5604c27703 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_group/index.md @@ -0,0 +1,83 @@ +--- +title: profiling_group +hide_title: false +hide_table_of_contents: false +keywords: + - profiling_group + - 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 +--- +Gets an individual profiling_group resource + +## Overview + + + + + +
Nameprofiling_group
TypeResource
Descriptionprofiling_group
Idawscc.codeguruprofiler.profiling_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
profiling_group_namestringThe name of the profiling group.
compute_platformstringThe compute platform of the profiling group.
agent_permissionsobjectThe agent permissions attached to this profiling group.
anomaly_detection_notification_configurationarrayConfiguration 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
arnstringThe Amazon Resource Name (ARN) of the specified profiling group.
tagsarrayThe tags associated with a profiling group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profiling_group resource, the following permissions are required: + +### Read +
+codeguru-profiler:DescribeProfilingGroup,
+codeguru-profiler:ListTagsForResource
+ +### Update +
+sns:Publish,
+codeguru-profiler:AddNotificationChannels,
+codeguru-profiler:GetNotificationConfiguration,
+codeguru-profiler:RemoveNotificationChannel,
+codeguru-profiler:PutPermission,
+codeguru-profiler:RemovePermission,
+codeguru-profiler:GetPolicy,
+codeguru-profiler:TagResource,
+codeguru-profiler:UntagResource,
+codeguru-profiler:ListTagsForResource
+ +### Delete +
+codeguru-profiler:DeleteProfilingGroup
+ + +## Example +```sql +SELECT +region, +profiling_group_name, +compute_platform, +agent_permissions, +anomaly_detection_notification_configuration, +arn, +tags +FROM awscc.codeguruprofiler.profiling_group +WHERE region = 'us-east-1' +AND data__Identifier = '<ProfilingGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md b/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md new file mode 100644 index 0000000000..7258809991 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md @@ -0,0 +1,63 @@ +--- +title: profiling_groups +hide_title: false +hide_table_of_contents: false +keywords: + - profiling_groups + - 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 +--- +Retrieves a list of profiling_groups in a region + +## Overview + + + + + +
Nameprofiling_groups
TypeResource
Descriptionprofiling_groups
Idawscc.codeguruprofiler.profiling_groups
+ +## Fields + + + + + +
NameDatatypeDescription
profiling_group_namestringThe name of the profiling group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profiling_groups resource, the following permissions are required: + +### Create +
+sns:Publish,
+codeguru-profiler:AddNotificationChannels,
+codeguru-profiler:CreateProfilingGroup,
+codeguru-profiler:PutPermission,
+codeguru-profiler:TagResource
+ +### List +
+codeguru-profiler:ListProfilingGroups,
+codeguru-profiler:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +profiling_group_name +FROM awscc.codeguruprofiler.profiling_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codegurureviewer/index.md b/docs/awscc-docs/providers/awscc/codegurureviewer/index.md new file mode 100644 index 0000000000..da97e437ff --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codegurureviewer/index.md @@ -0,0 +1,39 @@ +--- +title: codegurureviewer +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codegurureviewer service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+repository_association +
+
+repository_associations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codegurureviewer/repository_association/index.md b/docs/awscc-docs/providers/awscc/codegurureviewer/repository_association/index.md new file mode 100644 index 0000000000..07cb55ca1a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codegurureviewer/repository_association/index.md @@ -0,0 +1,78 @@ +--- +title: repository_association +hide_title: false +hide_table_of_contents: false +keywords: + - repository_association + - 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 +--- +Gets an individual repository_association resource + +## Overview + + + + + +
Namerepository_association
TypeResource
Descriptionrepository_association
Idawscc.codegurureviewer.repository_association
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the repository to be associated.
typestringThe type of repository to be associated.
ownerstringThe owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.
bucket_namestringThe name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.
connection_arnstringThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
association_arnstringThe Amazon Resource Name (ARN) of the repository association.
tagsarrayThe tags associated with a repository association.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repository_association resource, the following permissions are required: + +### Read +
+codeguru-reviewer:DescribeRepositoryAssociation,
+codeguru-reviewer:ListTagsForResource
+ +### Delete +
+codeguru-reviewer:DescribeRepositoryAssociation,
+codeguru-reviewer:DisassociateRepository,
+codecommit:UntagResource,
+events:DeleteRule,
+events:RemoveTargets,
+codestar-connections:UntagResource,
+codestar-connections:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +name, +type, +owner, +bucket_name, +connection_arn, +association_arn, +tags +FROM awscc.codegurureviewer.repository_association +WHERE region = 'us-east-1' +AND data__Identifier = '<AssociationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md b/docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md new file mode 100644 index 0000000000..489e1efe1e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md @@ -0,0 +1,73 @@ +--- +title: repository_associations +hide_title: false +hide_table_of_contents: false +keywords: + - repository_associations + - 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 +--- +Retrieves a list of repository_associations in a region + +## Overview + + + + + +
Namerepository_associations
TypeResource
Descriptionrepository_associations
Idawscc.codegurureviewer.repository_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_arnstringThe Amazon Resource Name (ARN) of the repository association.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repository_associations resource, the following permissions are required: + +### Create +
+codeguru-reviewer:DescribeRepositoryAssociation,
+codeguru-reviewer:AssociateRepository,
+codeguru-reviewer:TagResource,
+iam:CreateServiceLinkedRole,
+codecommit:TagResource,
+codecommit:GitPull,
+codecommit:TagResource,
+events:PutRule,
+events:PutTargets,
+codestar-connections:ListBranches,
+codestar-connections:ListRepositories,
+codestar-connections:ListTagsForResource,
+codestar-connections:PassConnection,
+codestar-connections:TagResource,
+codestar-connections:UseConnection,
+s3:ListBucket
+ +### List +
+codeguru-reviewer:ListRepositoryAssociations
+ + +## Example +```sql +SELECT +region, +association_arn +FROM awscc.codegurureviewer.repository_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codepipeline/custom_action_type/index.md b/docs/awscc-docs/providers/awscc/codepipeline/custom_action_type/index.md new file mode 100644 index 0000000000..227675f10e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codepipeline/custom_action_type/index.md @@ -0,0 +1,85 @@ +--- +title: custom_action_type +hide_title: false +hide_table_of_contents: false +keywords: + - custom_action_type + - 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 +--- +Gets an individual custom_action_type resource + +## Overview + + + + + +
Namecustom_action_type
TypeResource
Descriptioncustom_action_type
Idawscc.codepipeline.custom_action_type
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
categorystringThe category of the custom action, such as a build action or a test action.
configuration_propertiesarrayThe configuration properties for the custom action.
input_artifact_detailsobjectThe details of the input artifact for the action, such as its commit ID.
output_artifact_detailsobjectThe details of the output artifact of the action, such as its commit ID.
providerstringThe provider of the service used in the custom action, such as AWS CodeDeploy.
settingsobjectURLs that provide users information about this custom action.
tagsarrayAny tags assigned to the custom action.
versionstringThe version identifier of the custom action.
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_action_type resource, the following permissions are required: + +### Read +
+codepipeline:ListActionTypes,
+codepipeline:ListTagsForResource
+ +### Update +
+codepipeline:ListActionTypes,
+codepipeline:TagResource,
+codepipeline:UntagResource
+ +### Delete +
+codepipeline:DeleteCustomActionType,
+codepipeline:ListActionTypes
+ + +## Example +```sql +SELECT +region, +category, +configuration_properties, +input_artifact_details, +output_artifact_details, +provider, +settings, +tags, +version, +id +FROM awscc.codepipeline.custom_action_type +WHERE region = 'us-east-1' +AND data__Identifier = '<Category>' +AND data__Identifier = '<Provider>' +AND data__Identifier = '<Version>' +``` diff --git a/docs/awscc-docs/providers/awscc/codepipeline/custom_action_types/index.md b/docs/awscc-docs/providers/awscc/codepipeline/custom_action_types/index.md new file mode 100644 index 0000000000..b3a3809df9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codepipeline/custom_action_types/index.md @@ -0,0 +1,64 @@ +--- +title: custom_action_types +hide_title: false +hide_table_of_contents: false +keywords: + - custom_action_types + - 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 +--- +Retrieves a list of custom_action_types in a region + +## Overview + + + + + +
Namecustom_action_types
TypeResource
Descriptioncustom_action_types
Idawscc.codepipeline.custom_action_types
+ +## Fields + + + + + + + +
NameDatatypeDescription
categorystringThe category of the custom action, such as a build action or a test action.
providerstringThe provider of the service used in the custom action, such as AWS CodeDeploy.
versionstringThe version identifier of the custom action.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_action_types resource, the following permissions are required: + +### Create +
+codepipeline:CreateCustomActionType,
+codepipeline:TagResource,
+codepipeline:ListActionTypes
+ +### List +
+codepipeline:ListActionTypes
+ + +## Example +```sql +SELECT +region, +category, +provider, +version +FROM awscc.codepipeline.custom_action_types +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codepipeline/index.md b/docs/awscc-docs/providers/awscc/codepipeline/index.md new file mode 100644 index 0000000000..7058e3fe66 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codepipeline/index.md @@ -0,0 +1,39 @@ +--- +title: codepipeline +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codepipeline service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+custom_action_type +
+
+custom_action_types +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/connection/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/connection/index.md new file mode 100644 index 0000000000..41a69795da --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarconnections/connection/index.md @@ -0,0 +1,78 @@ +--- +title: connection +hide_title: false +hide_table_of_contents: false +keywords: + - connection + - 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 +--- +Gets an individual connection resource + +## Overview + + + + + +
Nameconnection
TypeResource
Descriptionconnection
Idawscc.codestarconnections.connection
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
connection_namestringThe name of the connection. Connection names must be unique in an AWS user account.
connection_statusstringThe current status of the connection.
owner_account_idstringThe 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.
provider_typestringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
host_arnstringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
tagsarraySpecifies the tags applied to a connection.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connection resource, the following permissions are required: + +### Read +
+codestar-connections:GetConnection,
+codestar-connections:ListTagsForResource
+ +### Update +
+codestar-connections:ListTagsForResource,
+codestar-connections:TagResource,
+codestar-connections:UntagResource
+ +### Delete +
+codestar-connections:DeleteConnection
+ + +## Example +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags +FROM awscc.codestarconnections.connection +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md new file mode 100644 index 0000000000..08a1092a59 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md @@ -0,0 +1,60 @@ +--- +title: connections +hide_title: false +hide_table_of_contents: false +keywords: + - connections + - 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 +--- +Retrieves a list of connections in a region + +## Overview + + + + + +
Nameconnections
TypeResource
Descriptionconnections
Idawscc.codestarconnections.connections
+ +## Fields + + + + + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connections resource, the following permissions are required: + +### Create +
+codestar-connections:CreateConnection,
+codestar-connections:TagResource
+ +### List +
+codestar-connections:ListConnections,
+codestar-connections:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +connection_arn +FROM awscc.codestarconnections.connections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/index.md new file mode 100644 index 0000000000..7678e23445 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarconnections/index.md @@ -0,0 +1,43 @@ +--- +title: codestarconnections +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codestarconnections service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+connection
+connections
+repository_link +
+
+repository_links
+sync_configuration
+sync_configurations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/repository_link/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/repository_link/index.md new file mode 100644 index 0000000000..7560f84453 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarconnections/repository_link/index.md @@ -0,0 +1,87 @@ +--- +title: repository_link +hide_title: false +hide_table_of_contents: false +keywords: + - repository_link + - 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 +--- +Gets an individual repository_link resource + +## Overview + + + + + +
Namerepository_link
TypeResource
Descriptionrepository_link
Idawscc.codestarconnections.repository_link
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.
provider_typestringThe name of the external provider where your third-party code repository is configured.
owner_idstringthe ID of the entity that owns the repository.
repository_namestringThe repository for which the link is being created.
encryption_key_arnstringThe 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.
repository_link_idstringA UUID that uniquely identifies the RepositoryLink.
repository_link_arnstringA unique Amazon Resource Name (ARN) to designate the repository link.
tagsarraySpecifies the tags applied to a RepositoryLink.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repository_link resource, the following permissions are required: + +### Update +
+codestar-connections:GetConnection,
+codestar-connections:ListTagsForResource,
+codestar-connections:PassConnection,
+codestar-connections:UseConnection,
+codestar-connections:TagResource,
+codestar-connections:UntagResource,
+codestar-connections:UpdateRepositoryLink
+ +### Read +
+codestar-connections:GetRepositoryLink,
+codestar-connections:ListTagsForResource,
+codestar-connections:GetConnection
+ +### Delete +
+codestar-connections:GetRepositoryLink,
+codestar-connections:DeleteRepositoryLink,
+codestar-connections:GetConnection
+ + +## Example +```sql +SELECT +region, +connection_arn, +provider_type, +owner_id, +repository_name, +encryption_key_arn, +repository_link_id, +repository_link_arn, +tags +FROM awscc.codestarconnections.repository_link +WHERE region = 'us-east-1' +AND data__Identifier = '<RepositoryLinkArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md new file mode 100644 index 0000000000..2c33a46ff6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md @@ -0,0 +1,64 @@ +--- +title: repository_links +hide_title: false +hide_table_of_contents: false +keywords: + - repository_links + - 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 +--- +Retrieves a list of repository_links in a region + +## Overview + + + + + +
Namerepository_links
TypeResource
Descriptionrepository_links
Idawscc.codestarconnections.repository_links
+ +## Fields + + + + + +
NameDatatypeDescription
repository_link_arnstringA unique Amazon Resource Name (ARN) to designate the repository link.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repository_links resource, the following permissions are required: + +### Create +
+codestar-connections:CreateRepositoryLink,
+codestar-connections:TagResource,
+codestar-connections:UseConnection,
+codestar-connections:PassConnection,
+codestar-connections:GetConnection,
+iam:CreateServiceLinkedRole
+ +### List +
+codestar-connections:ListRepositoryLinks,
+codestar-connections:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +repository_link_arn +FROM awscc.codestarconnections.repository_links +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md new file mode 100644 index 0000000000..8392c054b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md @@ -0,0 +1,83 @@ +--- +title: sync_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - sync_configuration + - 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 +--- +Gets an individual sync_configuration resource + +## Overview + + + + + +
Namesync_configuration
TypeResource
Descriptionsync_configuration
Idawscc.codestarconnections.sync_configuration
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
owner_idstringthe ID of the entity that owns the repository.
resource_namestringThe name of the resource that is being synchronized to the repository.
repository_namestringThe name of the repository that is being synced to.
provider_typestringThe name of the external provider where your third-party code repository is configured.
branchstringThe name of the branch of the repository from which resources are to be synchronized,
config_filestringThe source provider repository path of the sync configuration file of the respective SyncType.
sync_typestringThe type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
role_arnstringThe IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
repository_link_idstringA UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sync_configuration resource, the following permissions are required: + +### Read +
+codestar-connections:GetSyncConfiguration
+ +### Update +
+codestar-connections:UpdateSyncConfiguration,
+codestar-connections:PassRepository,
+iam:PassRole
+ +### Delete +
+codestar-connections:DeleteSyncConfiguration,
+codestar-connections:GetSyncConfiguration
+ + +## Example +```sql +SELECT +region, +owner_id, +resource_name, +repository_name, +provider_type, +branch, +config_file, +sync_type, +role_arn, +repository_link_id +FROM awscc.codestarconnections.sync_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceName>' +AND data__Identifier = '<SyncType>' +``` diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md new file mode 100644 index 0000000000..114f8186bd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md @@ -0,0 +1,63 @@ +--- +title: sync_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - sync_configurations + - 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 +--- +Retrieves a list of sync_configurations in a region + +## Overview + + + + + +
Namesync_configurations
TypeResource
Descriptionsync_configurations
Idawscc.codestarconnections.sync_configurations
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_namestringThe name of the resource that is being synchronized to the repository.
sync_typestringThe type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sync_configurations resource, the following permissions are required: + +### Create +
+codestar-connections:CreateSyncConfiguration,
+codestar-connections:PassRepository,
+iam:PassRole
+ +### List +
+codestar-connections:ListSyncConfigurations,
+codestar-connections:ListRepositoryLinks
+ + +## Example +```sql +SELECT +region, +resource_name, +sync_type +FROM awscc.codestarconnections.sync_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/codestarnotifications/index.md b/docs/awscc-docs/providers/awscc/codestarnotifications/index.md new file mode 100644 index 0000000000..0a57040898 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarnotifications/index.md @@ -0,0 +1,39 @@ +--- +title: codestarnotifications +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The codestarnotifications service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+notification_rule +
+
+notification_rules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rule/index.md b/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rule/index.md new file mode 100644 index 0000000000..5c425a68e0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rule/index.md @@ -0,0 +1,86 @@ +--- +title: notification_rule +hide_title: false +hide_table_of_contents: false +keywords: + - notification_rule + - 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 +--- +Gets an individual notification_rule resource + +## Overview + + + + + +
Namenotification_rule
TypeResource
Descriptionnotification_rule
Idawscc.codestarnotifications.notification_rule
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
event_type_idstring
created_bystring
target_addressstring
event_type_idsarray
statusstring
detail_typestring
resourcestring
targetsarray
tagsobject
namestring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the notification_rule resource, the following permissions are required: + +### Read +
+codestar-notifications:describeNotificationRule
+ +### Delete +
+codestar-notifications:deleteNotificationRule,
+codestar-notifications:describeNotificationRule
+ +### Update +
+codestar-notifications:updateNotificationRule,
+codestar-notifications:TagResource,
+codestar-notifications:UntagResource
+ + +## Example +```sql +SELECT +region, +event_type_id, +created_by, +target_address, +event_type_ids, +status, +detail_type, +resource, +targets, +tags, +name, +arn +FROM awscc.codestarnotifications.notification_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md b/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md new file mode 100644 index 0000000000..fe6a8fb915 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md @@ -0,0 +1,58 @@ +--- +title: notification_rules +hide_title: false +hide_table_of_contents: false +keywords: + - notification_rules + - 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 +--- +Retrieves a list of notification_rules in a region + +## Overview + + + + + +
Namenotification_rules
TypeResource
Descriptionnotification_rules
Idawscc.codestarnotifications.notification_rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the notification_rules resource, the following permissions are required: + +### Create +
+codestar-notifications:createNotificationRule
+ +### List +
+codestar-notifications:listNotificationRules
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.codestarnotifications.notification_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md new file mode 100644 index 0000000000..fc9a85a004 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md @@ -0,0 +1,91 @@ +--- +title: identity_pool +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool + - 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 +--- +Gets an individual identity_pool resource + +## Overview + + + + + +
Nameidentity_pool
TypeResource
Descriptionidentity_pool
Idawscc.cognito.identity_pool
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
push_syncobject
cognito_identity_providersarray
developer_provider_namestring
cognito_streamsobject
supported_login_providersobject
namestring
cognito_eventsobject
idstring
identity_pool_namestring
allow_unauthenticated_identitiesboolean
saml_provider_ar_nsarray
open_id_connect_provider_ar_nsarray
allow_classic_flowboolean
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_pool resource, the following permissions are required: + +### Read +
+cognito-identity:DescribeIdentityPool
+ +### Update +
+cognito-identity:UpdateIdentityPool,
+cognito-identity:DescribeIdentityPool,
+cognito-sync:SetIdentityPoolConfiguration,
+cognito-sync:SetCognitoEvents,
+iam:PassRole
+ +### Delete +
+cognito-identity:DeleteIdentityPool
+ + +## Example +```sql +SELECT +region, +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_ar_ns, +open_id_connect_provider_ar_ns, +allow_classic_flow +FROM awscc.cognito.identity_pool +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tag/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tag/index.md new file mode 100644 index 0000000000..8962c32e16 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tag/index.md @@ -0,0 +1,72 @@ +--- +title: identity_pool_principal_tag +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_principal_tag + - 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 +--- +Gets an individual identity_pool_principal_tag resource + +## Overview + + + + + +
Nameidentity_pool_principal_tag
TypeResource
Descriptionidentity_pool_principal_tag
Idawscc.cognito.identity_pool_principal_tag
+ +## Fields + + + + + + + + +
NameDatatypeDescription
identity_pool_idstring
identity_provider_namestring
use_defaultsboolean
principal_tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_pool_principal_tag resource, the following permissions are required: + +### Read +
+cognito-identity:GetPrincipalTagAttributeMap
+ +### Update +
+cognito-identity:GetPrincipalTagAttributeMap,
+cognito-identity:SetPrincipalTagAttributeMap
+ +### Delete +
+cognito-identity:GetPrincipalTagAttributeMap,
+cognito-identity:SetPrincipalTagAttributeMap
+ + +## Example +```sql +SELECT +region, +identity_pool_id, +identity_provider_name, +use_defaults, +principal_tags +FROM awscc.cognito.identity_pool_principal_tag +WHERE region = 'us-east-1' +AND data__Identifier = '<IdentityPoolId>' +AND data__Identifier = '<IdentityProviderName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tags/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tags/index.md new file mode 100644 index 0000000000..41d5fab6bd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tags/index.md @@ -0,0 +1,61 @@ +--- +title: identity_pool_principal_tags +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_principal_tags + - 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 +--- +Retrieves a list of identity_pool_principal_tags in a region + +## Overview + + + + + +
Nameidentity_pool_principal_tags
TypeResource
Descriptionidentity_pool_principal_tags
Idawscc.cognito.identity_pool_principal_tags
+ +## Fields + + + + + + +
NameDatatypeDescription
identity_pool_idstring
identity_provider_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_pool_principal_tags resource, the following permissions are required: + +### Create +
+cognito-identity:GetPrincipalTagAttributeMap,
+cognito-identity:SetPrincipalTagAttributeMap
+ +### List +
+cognito-identity:GetPrincipalTagAttributeMap
+ + +## Example +```sql +SELECT +region, +identity_pool_id, +identity_provider_name +FROM awscc.cognito.identity_pool_principal_tags +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachment/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachment/index.md new file mode 100644 index 0000000000..fe44e4981b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachment/index.md @@ -0,0 +1,72 @@ +--- +title: identity_pool_role_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_role_attachment + - 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 +--- +Gets an individual identity_pool_role_attachment resource + +## Overview + + + + + +
Nameidentity_pool_role_attachment
TypeResource
Descriptionidentity_pool_role_attachment
Idawscc.cognito.identity_pool_role_attachment
+ +## Fields + + + + + + + + +
NameDatatypeDescription
identity_pool_idstring
rolesundefined
idstring
role_mappingsundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_pool_role_attachment resource, the following permissions are required: + +### Read +
+cognito-identity:GetIdentityPoolRoles
+ +### Update +
+cognito-identity:GetIdentityPoolRoles,
+cognito-identity:SetIdentityPoolRoles,
+iam:PassRole
+ +### Delete +
+cognito-identity:GetIdentityPoolRoles,
+cognito-identity:SetIdentityPoolRoles
+ + +## Example +```sql +SELECT +region, +identity_pool_id, +roles, +id, +role_mappings +FROM awscc.cognito.identity_pool_role_attachment +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachments/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachments/index.md new file mode 100644 index 0000000000..30d95d4675 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachments/index.md @@ -0,0 +1,60 @@ +--- +title: identity_pool_role_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_role_attachments + - 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 +--- +Retrieves a list of identity_pool_role_attachments in a region + +## Overview + + + + + +
Nameidentity_pool_role_attachments
TypeResource
Descriptionidentity_pool_role_attachments
Idawscc.cognito.identity_pool_role_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_pool_role_attachments resource, the following permissions are required: + +### Create +
+cognito-identity:GetIdentityPoolRoles,
+cognito-identity:SetIdentityPoolRoles,
+iam:PassRole
+ +### List +
+cognito-identity:GetIdentityPoolRoles
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cognito.identity_pool_role_attachments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md new file mode 100644 index 0000000000..86d23bdd54 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md @@ -0,0 +1,61 @@ +--- +title: identity_pools +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pools + - 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 +--- +Retrieves a list of identity_pools in a region + +## Overview + + + + + +
Nameidentity_pools
TypeResource
Descriptionidentity_pools
Idawscc.cognito.identity_pools
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_pools resource, the following permissions are required: + +### Create +
+cognito-identity:CreateIdentityPool,
+cognito-sync:SetIdentityPoolConfiguration,
+cognito-sync:SetCognitoEvents,
+iam:PassRole
+ +### List +
+cognito-identity:ListIdentityPools
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cognito.identity_pools +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/index.md b/docs/awscc-docs/providers/awscc/cognito/index.md new file mode 100644 index 0000000000..845c538ec0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/index.md @@ -0,0 +1,57 @@ +--- +title: cognito +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cognito service documentation. + +:::info Service Summary + +
+
+total resources: 20
+total selectable resources: 20
+total methods: 20
+
+
+ +::: + +## Resources +
+
+identity_pool
+identity_pool_principal_tag
+identity_pool_principal_tags
+identity_pool_role_attachment
+identity_pool_role_attachments
+identity_pools
+log_delivery_configuration
+log_delivery_configurations
+user_pool
+user_pool_client +
+
+user_pool_clients
+user_pool_group
+user_pool_groups
+user_pool_risk_configuration_attachment
+user_pool_risk_configuration_attachments
+user_pool_user
+user_pool_user_to_group_attachment
+user_pool_user_to_group_attachments
+user_pool_users
+user_pools +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cognito/log_delivery_configuration/index.md b/docs/awscc-docs/providers/awscc/cognito/log_delivery_configuration/index.md new file mode 100644 index 0000000000..27a9bf4b7f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/log_delivery_configuration/index.md @@ -0,0 +1,85 @@ +--- +title: log_delivery_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - log_delivery_configuration + - 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 +--- +Gets an individual log_delivery_configuration resource + +## Overview + + + + + +
Namelog_delivery_configuration
TypeResource
Descriptionlog_delivery_configuration
Idawscc.cognito.log_delivery_configuration
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
user_pool_idstring
log_configurationsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_delivery_configuration resource, the following permissions are required: + +### Read +
+cognito-idp:GetLogDeliveryConfiguration
+ +### Update +
+cognito-idp:GetLogDeliveryConfiguration,
+cognito-idp:SetLogDeliveryConfiguration,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups
+ +### Delete +
+cognito-idp:GetLogDeliveryConfiguration,
+cognito-idp:SetLogDeliveryConfiguration,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups
+ + +## Example +```sql +SELECT +region, +id, +user_pool_id, +log_configurations +FROM awscc.cognito.log_delivery_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/log_delivery_configurations/index.md b/docs/awscc-docs/providers/awscc/cognito/log_delivery_configurations/index.md new file mode 100644 index 0000000000..59535c613d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/log_delivery_configurations/index.md @@ -0,0 +1,63 @@ +--- +title: log_delivery_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - log_delivery_configurations + - 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 +--- +Retrieves a list of log_delivery_configurations in a region + +## Overview + + + + + +
Namelog_delivery_configurations
TypeResource
Descriptionlog_delivery_configurations
Idawscc.cognito.log_delivery_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_delivery_configurations resource, the following permissions are required: + +### Create +
+cognito-idp:GetLogDeliveryConfiguration,
+cognito-idp:SetLogDeliveryConfiguration,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.cognito.log_delivery_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool/index.md new file mode 100644 index 0000000000..ae7f9e2091 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool/index.md @@ -0,0 +1,124 @@ +--- +title: user_pool +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool + - 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 +--- +Gets an individual user_pool resource + +## Overview + + + + + +
Nameuser_pool
TypeResource
Descriptionuser_pool
Idawscc.cognito.user_pool
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
user_pool_namestring
policiesobject
account_recovery_settingobject
admin_create_user_configobject
alias_attributesarray
username_attributesarray
auto_verified_attributesarray
device_configurationobject
email_configurationobject
email_verification_messagestring
email_verification_subjectstring
deletion_protectionstring
lambda_configobject
mfa_configurationstring
enabled_mfasarray
sms_authentication_messagestring
sms_configurationobject
sms_verification_messagestring
schemaarray
username_configurationobject
user_attribute_update_settingsobject
user_pool_tagsobject
verification_message_templateobject
user_pool_add_onsobject
provider_namestring
provider_ur_lstring
arnstring
user_pool_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool resource, the following permissions are required: + +### Read +
+cognito-idp:DescribeUserPool
+ +### Update +
+cognito-idp:UpdateUserPool,
+cognito-idp:ListTagsForResource,
+cognito-idp:UntagResource,
+cognito-idp:TagResource,
+cognito-idp:SetUserPoolMfaConfig,
+cognito-idp:AddCustomAttributes,
+cognito-idp:DescribeUserPool,
+iam:PassRole
+ +### Delete +
+cognito-idp:DeleteUserPool
+ + +## Example +```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_ur_l, +arn, +user_pool_id +FROM awscc.cognito.user_pool +WHERE region = 'us-east-1' +AND data__Identifier = '<UserPoolId>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_client/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_client/index.md new file mode 100644 index 0000000000..4f33351d78 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_client/index.md @@ -0,0 +1,116 @@ +--- +title: user_pool_client +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_client + - 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 +--- +Gets an individual user_pool_client resource + +## Overview + + + + + +
Nameuser_pool_client
TypeResource
Descriptionuser_pool_client
Idawscc.cognito.user_pool_client
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
client_namestring
explicit_auth_flowsarray
generate_secretboolean
read_attributesarray
auth_session_validityinteger
refresh_token_validityinteger
access_token_validityinteger
id_token_validityinteger
token_validity_unitsobject
user_pool_idstring
write_attributesarray
allowed_oauth_flowsarray
allowed_oauth_flows_user_pool_clientboolean
allowed_oauth_scopesarray
callback_ur_lsarray
default_redirect_ur_istring
logout_ur_lsarray
supported_identity_providersarray
analytics_configurationobject
prevent_user_existence_errorsstring
enable_token_revocationboolean
enable_propagate_additional_user_context_databoolean
namestring
client_secretstring
client_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_client resource, the following permissions are required: + +### Read +
+cognito-idp:DescribeUserPoolClient
+ +### Update +
+cognito-idp:UpdateUserPoolClient,
+iam:PassRole,
+iam:PutRolePolicy
+ +### Delete +
+cognito-idp:DeleteUserPoolClient,
+iam:PutRolePolicy,
+iam:DeleteRolePolicy
+ + +## Example +```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_ur_ls, +default_redirect_ur_i, +logout_ur_ls, +supported_identity_providers, +analytics_configuration, +prevent_user_existence_errors, +enable_token_revocation, +enable_propagate_additional_user_context_data, +name, +client_secret, +client_id +FROM awscc.cognito.user_pool_client +WHERE region = 'us-east-1' +AND data__Identifier = '<UserPoolId>' +AND data__Identifier = '<ClientId>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_clients/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_clients/index.md new file mode 100644 index 0000000000..cf1f3994e2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_clients/index.md @@ -0,0 +1,63 @@ +--- +title: user_pool_clients +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_clients + - 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 +--- +Retrieves a list of user_pool_clients in a region + +## Overview + + + + + +
Nameuser_pool_clients
TypeResource
Descriptionuser_pool_clients
Idawscc.cognito.user_pool_clients
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_clients resource, the following permissions are required: + +### Create +
+cognito-idp:CreateUserPoolClient,
+iam:PassRole,
+iam:PutRolePolicy,
+iam:CreateServiceLinkedRole
+ +### List +
+cognito-idp:ListUserPoolClients
+ + +## Example +```sql +SELECT +region, +user_pool_id, +client_id +FROM awscc.cognito.user_pool_clients +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_group/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_group/index.md new file mode 100644 index 0000000000..9b2f620ab5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_group/index.md @@ -0,0 +1,76 @@ +--- +title: user_pool_group +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_group + - 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 +--- +Gets an individual user_pool_group resource + +## Overview + + + + + +
Nameuser_pool_group
TypeResource
Descriptionuser_pool_group
Idawscc.cognito.user_pool_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstring
group_namestring
precedenceinteger
role_arnstring
user_pool_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_group resource, the following permissions are required: + +### Read +
+cognito-idp:GetGroup
+ +### Update +
+cognito-idp:UpdateGroup,
+iam:PassRole,
+iam:PutRolePolicy
+ +### Delete +
+cognito-idp:DeleteGroup,
+cognito-idp:GetGroup,
+iam:PutRolePolicy
+ + +## Example +```sql +SELECT +region, +description, +group_name, +precedence, +role_arn, +user_pool_id +FROM awscc.cognito.user_pool_group +WHERE region = 'us-east-1' +AND data__Identifier = '<UserPoolId>' +AND data__Identifier = '<GroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_groups/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_groups/index.md new file mode 100644 index 0000000000..0a2c8c4807 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_groups/index.md @@ -0,0 +1,63 @@ +--- +title: user_pool_groups +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_groups + - 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 +--- +Retrieves a list of user_pool_groups in a region + +## Overview + + + + + +
Nameuser_pool_groups
TypeResource
Descriptionuser_pool_groups
Idawscc.cognito.user_pool_groups
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
group_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_groups resource, the following permissions are required: + +### Create +
+cognito-idp:CreateGroup,
+iam:PassRole,
+iam:PutRolePolicy,
+cognito-idp:GetGroup
+ +### List +
+cognito-idp:ListGroups
+ + +## Example +```sql +SELECT +region, +user_pool_id, +group_name +FROM awscc.cognito.user_pool_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachment/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachment/index.md new file mode 100644 index 0000000000..b2e3d99009 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachment/index.md @@ -0,0 +1,75 @@ +--- +title: user_pool_risk_configuration_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_risk_configuration_attachment + - 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 +--- +Gets an individual user_pool_risk_configuration_attachment resource + +## Overview + + + + + +
Nameuser_pool_risk_configuration_attachment
TypeResource
Descriptionuser_pool_risk_configuration_attachment
Idawscc.cognito.user_pool_risk_configuration_attachment
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
risk_exception_configurationobject
compromised_credentials_risk_configurationobject
account_takeover_risk_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_risk_configuration_attachment resource, the following permissions are required: + +### Read +
+cognito-idp:DescribeRiskConfiguration
+ +### Update +
+cognito-idp:SetRiskConfiguration,
+cognito-idp:DescribeRiskConfiguration,
+iam:PassRole
+ +### Delete +
+cognito-idp:SetRiskConfiguration,
+cognito-idp:DescribeRiskConfiguration
+ + +## Example +```sql +SELECT +region, +user_pool_id, +client_id, +risk_exception_configuration, +compromised_credentials_risk_configuration, +account_takeover_risk_configuration +FROM awscc.cognito.user_pool_risk_configuration_attachment +WHERE region = 'us-east-1' +AND data__Identifier = '<UserPoolId>' +AND data__Identifier = '<ClientId>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachments/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachments/index.md new file mode 100644 index 0000000000..b827abcde2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachments/index.md @@ -0,0 +1,58 @@ +--- +title: user_pool_risk_configuration_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_risk_configuration_attachments + - 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 +--- +Retrieves a list of user_pool_risk_configuration_attachments in a region + +## Overview + + + + + +
Nameuser_pool_risk_configuration_attachments
TypeResource
Descriptionuser_pool_risk_configuration_attachments
Idawscc.cognito.user_pool_risk_configuration_attachments
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_risk_configuration_attachments resource, the following permissions are required: + +### Create +
+cognito-idp:SetRiskConfiguration,
+cognito-idp:DescribeRiskConfiguration,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +user_pool_id, +client_id +FROM awscc.cognito.user_pool_risk_configuration_attachments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_user/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_user/index.md new file mode 100644 index 0000000000..486bcb41ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_user/index.md @@ -0,0 +1,74 @@ +--- +title: user_pool_user +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_user + - 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 +--- +Gets an individual user_pool_user resource + +## Overview + + + + + +
Nameuser_pool_user
TypeResource
Descriptionuser_pool_user
Idawscc.cognito.user_pool_user
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
desired_delivery_mediumsarray
force_alias_creationboolean
user_attributesarray
message_actionstring
usernamestring
user_pool_idstring
validation_dataarray
client_metadataobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_user resource, the following permissions are required: + +### Read +
+cognito-idp:AdminGetUser
+ +### Delete +
+cognito-idp:AdminDeleteUser
+ + +## Example +```sql +SELECT +region, +desired_delivery_mediums, +force_alias_creation, +user_attributes, +message_action, +username, +user_pool_id, +validation_data, +client_metadata +FROM awscc.cognito.user_pool_user +WHERE region = 'us-east-1' +AND data__Identifier = '<UserPoolId>' +AND data__Identifier = '<Username>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachment/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachment/index.md new file mode 100644 index 0000000000..189bc6e979 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachment/index.md @@ -0,0 +1,66 @@ +--- +title: user_pool_user_to_group_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_user_to_group_attachment + - 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 +--- +Gets an individual user_pool_user_to_group_attachment resource + +## Overview + + + + + +
Nameuser_pool_user_to_group_attachment
TypeResource
Descriptionuser_pool_user_to_group_attachment
Idawscc.cognito.user_pool_user_to_group_attachment
+ +## Fields + + + + + + + +
NameDatatypeDescription
user_pool_idstring
usernamestring
group_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_user_to_group_attachment resource, the following permissions are required: + +### Delete +
+cognito-idp:AdminRemoveUserFromGroup,
+cognito-idp:AdminListGroupsForUser
+ +### Read +
+cognito-idp:AdminListGroupsForUser
+ + +## Example +```sql +SELECT +region, +user_pool_id, +username, +group_name +FROM awscc.cognito.user_pool_user_to_group_attachment +WHERE region = 'us-east-1' +AND data__Identifier = '<UserPoolId>' +AND data__Identifier = '<GroupName>' +AND data__Identifier = '<Username>' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachments/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachments/index.md new file mode 100644 index 0000000000..774b164ef3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachments/index.md @@ -0,0 +1,59 @@ +--- +title: user_pool_user_to_group_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_user_to_group_attachments + - 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 +--- +Retrieves a list of user_pool_user_to_group_attachments in a region + +## Overview + + + + + +
Nameuser_pool_user_to_group_attachments
TypeResource
Descriptionuser_pool_user_to_group_attachments
Idawscc.cognito.user_pool_user_to_group_attachments
+ +## Fields + + + + + + + +
NameDatatypeDescription
user_pool_idstring
group_namestring
usernamestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_user_to_group_attachments resource, the following permissions are required: + +### Create +
+cognito-idp:AdminAddUserToGroup,
+cognito-idp:AdminListGroupsForUser
+ + +## Example +```sql +SELECT +region, +user_pool_id, +group_name, +username +FROM awscc.cognito.user_pool_user_to_group_attachments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool_users/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool_users/index.md new file mode 100644 index 0000000000..b5b423f668 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pool_users/index.md @@ -0,0 +1,62 @@ +--- +title: user_pool_users +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_users + - 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 +--- +Retrieves a list of user_pool_users in a region + +## Overview + + + + + +
Nameuser_pool_users
TypeResource
Descriptionuser_pool_users
Idawscc.cognito.user_pool_users
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
usernamestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pool_users resource, the following permissions are required: + +### Create +
+cognito-idp:AdminCreateUser,
+cognito-idp:AdminGetUser,
+iam:PassRole
+ +### List +
+cognito-idp:ListUsers
+ + +## Example +```sql +SELECT +region, +user_pool_id, +username +FROM awscc.cognito.user_pool_users +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pools/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pools/index.md new file mode 100644 index 0000000000..c3e0563772 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cognito/user_pools/index.md @@ -0,0 +1,63 @@ +--- +title: user_pools +hide_title: false +hide_table_of_contents: false +keywords: + - user_pools + - 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 +--- +Retrieves a list of user_pools in a region + +## Overview + + + + + +
Nameuser_pools
TypeResource
Descriptionuser_pools
Idawscc.cognito.user_pools
+ +## Fields + + + + + +
NameDatatypeDescription
user_pool_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_pools resource, the following permissions are required: + +### Create +
+cognito-idp:CreateUserPool,
+iam:PassRole,
+cognito-idp:SetUserPoolMfaConfig,
+cognito-idp:DescribeUserPool,
+kms:CreateGrant,
+iam:CreateServiceLinkedRole
+ +### List +
+cognito-idp:ListUserPools
+ + +## Example +```sql +SELECT +region, +user_pool_id +FROM awscc.cognito.user_pools +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md b/docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md new file mode 100644 index 0000000000..f7e93a0932 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md @@ -0,0 +1,97 @@ +--- +title: document_classifier +hide_title: false +hide_table_of_contents: false +keywords: + - document_classifier + - 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 +--- +Gets an individual document_classifier resource + +## Overview + + + + + +
Namedocument_classifier
TypeResource
Descriptiondocument_classifier
Idawscc.comprehend.document_classifier
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
data_access_role_arnstring
input_data_configobject
output_data_configobject
language_codestring
model_kms_key_idstring
model_policystring
document_classifier_namestring
modestring
tagsarray
version_namestring
volume_kms_key_idstring
vpc_configobject
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the document_classifier resource, the following permissions are required: + +### Read +
+comprehend:DescribeDocumentClassifier,
+comprehend:DescribeResourcePolicy,
+comprehend:ListTagsForResource
+ +### Update +
+iam:PassRole,
+comprehend:PutResourcePolicy,
+comprehend:DeleteResourcePolicy,
+comprehend:DescribeResourcePolicy,
+comprehend:DescribeDocumentClassifier,
+comprehend:ListTagsForResource,
+comprehend:TagResource,
+comprehend:UntagResource
+ +### Delete +
+comprehend:DescribeDocumentClassifier,
+comprehend:DeleteDocumentClassifier
+ + +## Example +```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 awscc.comprehend.document_classifier +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md b/docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md new file mode 100644 index 0000000000..65edae6a43 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md @@ -0,0 +1,63 @@ +--- +title: document_classifiers +hide_title: false +hide_table_of_contents: false +keywords: + - document_classifiers + - 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 +--- +Retrieves a list of document_classifiers in a region + +## Overview + + + + + +
Namedocument_classifiers
TypeResource
Descriptiondocument_classifiers
Idawscc.comprehend.document_classifiers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the document_classifiers resource, the following permissions are required: + +### Create +
+iam:PassRole,
+comprehend:CreateDocumentClassifier,
+comprehend:DescribeDocumentClassifier,
+comprehend:DescribeResourcePolicy,
+comprehend:ListTagsForResource,
+textract:DetectDocumentText
+ +### List +
+comprehend:ListDocumentClassifiers
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.comprehend.document_classifiers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md b/docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md new file mode 100644 index 0000000000..73c877e14a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md @@ -0,0 +1,86 @@ +--- +title: flywheel +hide_title: false +hide_table_of_contents: false +keywords: + - flywheel + - 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 +--- +Gets an individual flywheel resource + +## Overview + + + + + +
Nameflywheel
TypeResource
Descriptionflywheel
Idawscc.comprehend.flywheel
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
active_model_arnstring
data_access_role_arnstring
data_lake_s3_uristring
data_security_configobject
flywheel_namestring
model_typestring
tagsarray
task_configobject
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flywheel resource, the following permissions are required: + +### Read +
+comprehend:DescribeFlywheel,
+comprehend:ListTagsForResource
+ +### Update +
+iam:PassRole,
+comprehend:DescribeFlywheel,
+comprehend:UpdateFlywheel,
+comprehend:ListTagsForResource,
+comprehend:TagResource,
+comprehend:UntagResource
+ +### Delete +
+comprehend:DeleteFlywheel,
+comprehend:DescribeFlywheel
+ + +## Example +```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 awscc.comprehend.flywheel +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md b/docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md new file mode 100644 index 0000000000..66f51ef8fb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md @@ -0,0 +1,61 @@ +--- +title: flywheels +hide_title: false +hide_table_of_contents: false +keywords: + - flywheels + - 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 +--- +Retrieves a list of flywheels in a region + +## Overview + + + + + +
Nameflywheels
TypeResource
Descriptionflywheels
Idawscc.comprehend.flywheels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flywheels resource, the following permissions are required: + +### Create +
+iam:PassRole,
+comprehend:CreateFlywheel,
+comprehend:DescribeFlywheel,
+comprehend:ListTagsForResource
+ +### List +
+comprehend:ListFlywheels
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.comprehend.flywheels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/comprehend/index.md b/docs/awscc-docs/providers/awscc/comprehend/index.md new file mode 100644 index 0000000000..bd99662060 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/comprehend/index.md @@ -0,0 +1,41 @@ +--- +title: comprehend +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The comprehend service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+document_classifier
+document_classifiers +
+
+flywheel
+flywheels +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/config/aggregation_authorization/index.md b/docs/awscc-docs/providers/awscc/config/aggregation_authorization/index.md new file mode 100644 index 0000000000..f03dccfe0b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/aggregation_authorization/index.md @@ -0,0 +1,76 @@ +--- +title: aggregation_authorization +hide_title: false +hide_table_of_contents: false +keywords: + - aggregation_authorization + - 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 +--- +Gets an individual aggregation_authorization resource + +## Overview + + + + + +
Nameaggregation_authorization
TypeResource
Descriptionaggregation_authorization
Idawscc.config.aggregation_authorization
+ +## Fields + + + + + + + + +
NameDatatypeDescription
authorized_account_idstringThe 12-digit account ID of the account authorized to aggregate data.
authorized_aws_regionstringThe region authorized to collect aggregated data.
aggregation_authorization_arnstringThe ARN of the AggregationAuthorization.
tagsarrayThe tags for the AggregationAuthorization.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the aggregation_authorization resource, the following permissions are required: + +### Update +
+config:DescribeAggregationAuthorizations,
+config:TagResource,
+config:UntagResource,
+config:ListTagsForResource
+ +### Read +
+config:DescribeAggregationAuthorizations,
+config:ListTagsForResource
+ +### Delete +
+config:DescribeAggregationAuthorizations,
+config:DeleteAggregationAuthorization,
+config:UntagResource
+ + +## Example +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region, +aggregation_authorization_arn, +tags +FROM awscc.config.aggregation_authorization +WHERE region = 'us-east-1' +AND data__Identifier = '<AuthorizedAccountId>' +AND data__Identifier = '<AuthorizedAwsRegion>' +``` diff --git a/docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md b/docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md new file mode 100644 index 0000000000..55d714e984 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md @@ -0,0 +1,62 @@ +--- +title: aggregation_authorizations +hide_title: false +hide_table_of_contents: false +keywords: + - aggregation_authorizations + - 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 +--- +Retrieves a list of aggregation_authorizations in a region + +## Overview + + + + + +
Nameaggregation_authorizations
TypeResource
Descriptionaggregation_authorizations
Idawscc.config.aggregation_authorizations
+ +## Fields + + + + + + +
NameDatatypeDescription
authorized_account_idstringThe 12-digit account ID of the account authorized to aggregate data.
authorized_aws_regionstringThe region authorized to collect aggregated data.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the aggregation_authorizations resource, the following permissions are required: + +### Create +
+config:DescribeAggregationAuthorizations,
+config:PutAggregationAuthorization,
+config:TagResource
+ +### List +
+config:DescribeAggregationAuthorizations
+ + +## Example +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region +FROM awscc.config.aggregation_authorizations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/config/config_rule/index.md b/docs/awscc-docs/providers/awscc/config/config_rule/index.md new file mode 100644 index 0000000000..9596448561 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/config_rule/index.md @@ -0,0 +1,84 @@ +--- +title: config_rule +hide_title: false +hide_table_of_contents: false +keywords: + - config_rule + - 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 +--- +Gets an individual config_rule resource + +## Overview + + + + + +
Nameconfig_rule
TypeResource
Descriptionconfig_rule
Idawscc.config.config_rule
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
config_rule_idstring
descriptionstringThe description that you provide for the CC rule.
scopeobjectDefines 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.<br/> The scope can be empty.
config_rule_namestringA 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).
arnstring
complianceobjectIndicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.
maximum_execution_frequencystringThe maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when:<br/> + You are using an AWS managed rule that is triggered at a periodic frequency.<br/> + 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).<br/> <br/> By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.
sourceobjectProvides 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.
input_parametersobjectA string, in JSON format, that is passed to the CC rule Lambda function.
evaluation_modesarrayThe modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the config_rule resource, the following permissions are required: + +### Read +
+config:DescribeConfigRules,
+config:DescribeComplianceByConfigRule
+ +### Delete +
+config:DeleteConfigRule,
+config:DescribeConfigRules
+ +### Update +
+config:PutConfigRule,
+config:DescribeConfigRules
+ + +## Example +```sql +SELECT +region, +config_rule_id, +description, +scope, +config_rule_name, +arn, +compliance, +maximum_execution_frequency, +source, +input_parameters, +evaluation_modes +FROM awscc.config.config_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<ConfigRuleName>' +``` diff --git a/docs/awscc-docs/providers/awscc/config/config_rules/index.md b/docs/awscc-docs/providers/awscc/config/config_rules/index.md new file mode 100644 index 0000000000..d0ff2fae88 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/config_rules/index.md @@ -0,0 +1,59 @@ +--- +title: config_rules +hide_title: false +hide_table_of_contents: false +keywords: + - config_rules + - 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 +--- +Retrieves a list of config_rules in a region + +## Overview + + + + + +
Nameconfig_rules
TypeResource
Descriptionconfig_rules
Idawscc.config.config_rules
+ +## Fields + + + + + +
NameDatatypeDescription
config_rule_namestringA 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).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the config_rules resource, the following permissions are required: + +### Create +
+config:PutConfigRule,
+config:DescribeConfigRules
+ +### List +
+config:DescribeConfigRules
+ + +## Example +```sql +SELECT +region, +config_rule_name +FROM awscc.config.config_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md b/docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md new file mode 100644 index 0000000000..ab953f9d38 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md @@ -0,0 +1,80 @@ +--- +title: configuration_aggregator +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_aggregator + - 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 +--- +Gets an individual configuration_aggregator resource + +## Overview + + + + + +
Nameconfiguration_aggregator
TypeResource
Descriptionconfiguration_aggregator
Idawscc.config.configuration_aggregator
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
account_aggregation_sourcesarray
configuration_aggregator_namestringThe name of the aggregator.
configuration_aggregator_arnstringThe Amazon Resource Name (ARN) of the aggregator.
organization_aggregation_sourceobject
tagsarrayThe tags for the configuration aggregator.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_aggregator resource, the following permissions are required: + +### Read +
+config:DescribeConfigurationAggregators,
+config:ListTagsForResource
+ +### Update +
+config:PutConfigurationAggregator,
+config:DescribeConfigurationAggregators,
+config:TagResource,
+config:UntagResource,
+config:ListTagsForResource,
+iam:PassRole,
+organizations:EnableAWSServiceAccess,
+organizations:ListDelegatedAdministrators
+ +### Delete +
+config:DeleteConfigurationAggregator,
+config:UntagResource
+ + +## Example +```sql +SELECT +region, +account_aggregation_sources, +configuration_aggregator_name, +configuration_aggregator_arn, +organization_aggregation_source, +tags +FROM awscc.config.configuration_aggregator +WHERE region = 'us-east-1' +AND data__Identifier = '<ConfigurationAggregatorName>' +``` diff --git a/docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md b/docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md new file mode 100644 index 0000000000..6cf48489fc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md @@ -0,0 +1,63 @@ +--- +title: configuration_aggregators +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_aggregators + - 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 +--- +Retrieves a list of configuration_aggregators in a region + +## Overview + + + + + +
Nameconfiguration_aggregators
TypeResource
Descriptionconfiguration_aggregators
Idawscc.config.configuration_aggregators
+ +## Fields + + + + + +
NameDatatypeDescription
configuration_aggregator_namestringThe name of the aggregator.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_aggregators resource, the following permissions are required: + +### Create +
+config:PutConfigurationAggregator,
+config:DescribeConfigurationAggregators,
+config:TagResource,
+iam:PassRole,
+organizations:EnableAWSServiceAccess,
+organizations:ListDelegatedAdministrators
+ +### List +
+config:DescribeConfigurationAggregators
+ + +## Example +```sql +SELECT +region, +configuration_aggregator_name +FROM awscc.config.configuration_aggregators +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/config/conformance_pack/index.md b/docs/awscc-docs/providers/awscc/config/conformance_pack/index.md new file mode 100644 index 0000000000..a36d4c0f28 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/conformance_pack/index.md @@ -0,0 +1,81 @@ +--- +title: conformance_pack +hide_title: false +hide_table_of_contents: false +keywords: + - conformance_pack + - 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 +--- +Gets an individual conformance_pack resource + +## Overview + + + + + +
Nameconformance_pack
TypeResource
Descriptionconformance_pack
Idawscc.config.conformance_pack
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
conformance_pack_namestringName of the conformance pack which will be assigned as the unique identifier.
delivery_s3_bucketstringAWS Config stores intermediate files while processing conformance pack template.
delivery_s3_key_prefixstringThe prefix for delivery S3 bucket.
template_bodystringA string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
template_s3_uristringLocation 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.
template_ss_mdocument_detailsobjectThe TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
conformance_pack_input_parametersarrayA list of ConformancePackInputParameter objects.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the conformance_pack resource, the following permissions are required: + +### Read +
+config:DescribeConformancePacks
+ +### Update +
+config:PutConformancePack,
+config:DescribeConformancePackStatus,
+s3:GetObject,
+s3:GetBucketAcl,
+iam:CreateServiceLinkedRole,
+iam:PassRole
+ +### Delete +
+config:DeleteConformancePack,
+config:DescribeConformancePackStatus
+ + +## Example +```sql +SELECT +region, +conformance_pack_name, +delivery_s3_bucket, +delivery_s3_key_prefix, +template_body, +template_s3_uri, +template_ss_mdocument_details, +conformance_pack_input_parameters +FROM awscc.config.conformance_pack +WHERE region = 'us-east-1' +AND data__Identifier = '<ConformancePackName>' +``` diff --git a/docs/awscc-docs/providers/awscc/config/conformance_packs/index.md b/docs/awscc-docs/providers/awscc/config/conformance_packs/index.md new file mode 100644 index 0000000000..597406113c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/conformance_packs/index.md @@ -0,0 +1,64 @@ +--- +title: conformance_packs +hide_title: false +hide_table_of_contents: false +keywords: + - conformance_packs + - 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 +--- +Retrieves a list of conformance_packs in a region + +## Overview + + + + + +
Nameconformance_packs
TypeResource
Descriptionconformance_packs
Idawscc.config.conformance_packs
+ +## Fields + + + + + +
NameDatatypeDescription
conformance_pack_namestringName of the conformance pack which will be assigned as the unique identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the conformance_packs resource, the following permissions are required: + +### Create +
+config:PutConformancePack,
+config:DescribeConformancePackStatus,
+config:DescribeConformancePacks,
+s3:GetObject,
+s3:GetBucketAcl,
+iam:CreateServiceLinkedRole,
+iam:PassRole
+ +### List +
+config:DescribeConformancePacks
+ + +## Example +```sql +SELECT +region, +conformance_pack_name +FROM awscc.config.conformance_packs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/config/index.md b/docs/awscc-docs/providers/awscc/config/index.md new file mode 100644 index 0000000000..0a6e09afad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/index.md @@ -0,0 +1,49 @@ +--- +title: config +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The config service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+aggregation_authorization
+aggregation_authorizations
+config_rule
+config_rules
+configuration_aggregator
+configuration_aggregators +
+
+conformance_pack
+conformance_packs
+organization_conformance_pack
+organization_conformance_packs
+stored_queries
+stored_query +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/config/organization_conformance_pack/index.md b/docs/awscc-docs/providers/awscc/config/organization_conformance_pack/index.md new file mode 100644 index 0000000000..2a1e43324e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/organization_conformance_pack/index.md @@ -0,0 +1,86 @@ +--- +title: organization_conformance_pack +hide_title: false +hide_table_of_contents: false +keywords: + - organization_conformance_pack + - 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 +--- +Gets an individual organization_conformance_pack resource + +## Overview + + + + + +
Nameorganization_conformance_pack
TypeResource
Descriptionorganization_conformance_pack
Idawscc.config.organization_conformance_pack
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
organization_conformance_pack_namestringThe name of the organization conformance pack.
template_s3_uristringLocation of file containing the template body.
template_bodystringA string containing full conformance pack template body.
delivery_s3_bucketstringAWS Config stores intermediate files while processing conformance pack template.
delivery_s3_key_prefixstringThe prefix for the delivery S3 bucket.
conformance_pack_input_parametersarrayA list of ConformancePackInputParameter objects.
excluded_accountsarrayA list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organization_conformance_pack resource, the following permissions are required: + +### Read +
+config:DescribeOrganizationConformancePacks
+ +### Delete +
+config:DeleteOrganizationConformancePack,
+config:DescribeOrganizationConformancePackStatuses,
+config:GetOrganizationConformancePackDetailedStatus,
+organizations:ListDelegatedAdministrators
+ +### Update +
+config:PutOrganizationConformancePack,
+config:DescribeOrganizationConformancePackStatuses,
+config:GetOrganizationConformancePackDetailedStatus,
+s3:GetObject,
+s3:GetBucketAcl,
+iam:CreateServiceLinkedRole,
+iam:PassRole,
+organizations:ListDelegatedAdministrators,
+organizations:EnableAWSServiceAccess
+ + +## Example +```sql +SELECT +region, +organization_conformance_pack_name, +template_s3_uri, +template_body, +delivery_s3_bucket, +delivery_s3_key_prefix, +conformance_pack_input_parameters, +excluded_accounts +FROM awscc.config.organization_conformance_pack +WHERE region = 'us-east-1' +AND data__Identifier = '<OrganizationConformancePackName>' +``` diff --git a/docs/awscc-docs/providers/awscc/config/organization_conformance_packs/index.md b/docs/awscc-docs/providers/awscc/config/organization_conformance_packs/index.md new file mode 100644 index 0000000000..15dff7859e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/organization_conformance_packs/index.md @@ -0,0 +1,67 @@ +--- +title: organization_conformance_packs +hide_title: false +hide_table_of_contents: false +keywords: + - organization_conformance_packs + - 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 +--- +Retrieves a list of organization_conformance_packs in a region + +## Overview + + + + + +
Nameorganization_conformance_packs
TypeResource
Descriptionorganization_conformance_packs
Idawscc.config.organization_conformance_packs
+ +## Fields + + + + + +
NameDatatypeDescription
organization_conformance_pack_namestringThe name of the organization conformance pack.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organization_conformance_packs resource, the following permissions are required: + +### Create +
+config:PutOrganizationConformancePack,
+config:DescribeOrganizationConformancePackStatuses,
+config:GetOrganizationConformancePackDetailedStatus,
+config:DescribeOrganizationConformancePacks,
+s3:GetObject,
+s3:GetBucketAcl,
+iam:CreateServiceLinkedRole,
+iam:PassRole,
+organizations:ListDelegatedAdministrators,
+organizations:EnableAWSServiceAccess
+ +### List +
+config:DescribeOrganizationConformancePacks
+ + +## Example +```sql +SELECT +region, +organization_conformance_pack_name +FROM awscc.config.organization_conformance_packs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/config/stored_queries/index.md b/docs/awscc-docs/providers/awscc/config/stored_queries/index.md new file mode 100644 index 0000000000..f2de46cead --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/stored_queries/index.md @@ -0,0 +1,60 @@ +--- +title: stored_queries +hide_title: false +hide_table_of_contents: false +keywords: + - stored_queries + - 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 +--- +Retrieves a list of stored_queries in a region + +## Overview + + + + + +
Namestored_queries
TypeResource
Descriptionstored_queries
Idawscc.config.stored_queries
+ +## Fields + + + + + +
NameDatatypeDescription
query_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stored_queries resource, the following permissions are required: + +### Create +
+config:PutStoredQuery,
+config:GetStoredQuery,
+config:TagResource
+ +### List +
+config:ListStoredQueries
+ + +## Example +```sql +SELECT +region, +query_name +FROM awscc.config.stored_queries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/config/stored_query/index.md b/docs/awscc-docs/providers/awscc/config/stored_query/index.md new file mode 100644 index 0000000000..4be054cdcc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/config/stored_query/index.md @@ -0,0 +1,79 @@ +--- +title: stored_query +hide_title: false +hide_table_of_contents: false +keywords: + - stored_query + - 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 +--- +Gets an individual stored_query resource + +## Overview + + + + + +
Namestored_query
TypeResource
Descriptionstored_query
Idawscc.config.stored_query
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
query_arnstring
query_idstring
query_namestring
query_descriptionstring
query_expressionstring
tagsarrayThe tags for the stored query.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stored_query resource, the following permissions are required: + +### Read +
+config:GetStoredQuery,
+config:ListTagsForResource
+ +### Update +
+config:PutStoredQuery,
+config:GetStoredQuery,
+config:TagResource,
+config:UntagResource,
+config:ListTagsForResource
+ +### Delete +
+config:DeleteStoredQuery,
+config:UntagResource
+ + +## Example +```sql +SELECT +region, +query_arn, +query_id, +query_name, +query_description, +query_expression, +tags +FROM awscc.config.stored_query +WHERE region = 'us-east-1' +AND data__Identifier = '<QueryName>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/approved_origin/index.md b/docs/awscc-docs/providers/awscc/connect/approved_origin/index.md new file mode 100644 index 0000000000..f68c232952 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/approved_origin/index.md @@ -0,0 +1,67 @@ +--- +title: approved_origin +hide_title: false +hide_table_of_contents: false +keywords: + - approved_origin + - 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 +--- +Gets an individual approved_origin resource + +## Overview + + + + + +
Nameapproved_origin
TypeResource
Descriptionapproved_origin
Idawscc.connect.approved_origin
+ +## Fields + + + + + + +
NameDatatypeDescription
originstring
instance_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the approved_origin resource, the following permissions are required: + +### Read +
+connect:ListApprovedOrigins
+ +### Update +
+
+ +### Delete +
+connect:DisassociateApprovedOrigin,
+connect:ListApprovedOrigins
+ + +## Example +```sql +SELECT +region, +origin, +instance_id +FROM awscc.connect.approved_origin +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceId>' +AND data__Identifier = '<Origin>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/approved_origins/index.md b/docs/awscc-docs/providers/awscc/connect/approved_origins/index.md new file mode 100644 index 0000000000..4fa4127957 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/approved_origins/index.md @@ -0,0 +1,61 @@ +--- +title: approved_origins +hide_title: false +hide_table_of_contents: false +keywords: + - approved_origins + - 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 +--- +Retrieves a list of approved_origins in a region + +## Overview + + + + + +
Nameapproved_origins
TypeResource
Descriptionapproved_origins
Idawscc.connect.approved_origins
+ +## Fields + + + + + + +
NameDatatypeDescription
instance_idundefined
originundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the approved_origins resource, the following permissions are required: + +### Create +
+connect:AssociateApprovedOrigin,
+connect:ListApprovedOrigins
+ +### List +
+connect:ListApprovedOrigins
+ + +## Example +```sql +SELECT +region, +instance_id, +origin +FROM awscc.connect.approved_origins +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/contact_flow/index.md b/docs/awscc-docs/providers/awscc/connect/contact_flow/index.md new file mode 100644 index 0000000000..d7288e5b50 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/contact_flow/index.md @@ -0,0 +1,81 @@ +--- +title: contact_flow +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow + - 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 +--- +Gets an individual contact_flow resource + +## Overview + + + + + +
Namecontact_flow
TypeResource
Descriptioncontact_flow
Idawscc.connect.contact_flow
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance (ARN).
contact_flow_arnstringThe identifier of the contact flow (ARN).
namestringThe name of the contact flow.
contentstringThe content of the contact flow in JSON format.
descriptionstringThe description of the contact flow.
statestringThe state of the contact flow.
typestringThe type of the contact flow.
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_flow resource, the following permissions are required: + +### Read +
+connect:DescribeContactFlow
+ +### Delete +
+connect:DeleteContactFlow,
+connect:UntagResource
+ +### Update +
+connect:UpdateContactFlowMetadata,
+connect:UpdateContactFlowContent,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +contact_flow_arn, +name, +content, +description, +state, +type, +tags +FROM awscc.connect.contact_flow +WHERE region = 'us-east-1' +AND data__Identifier = '<ContactFlowArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/contact_flow_module/index.md b/docs/awscc-docs/providers/awscc/connect/contact_flow_module/index.md new file mode 100644 index 0000000000..cedf84e278 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/contact_flow_module/index.md @@ -0,0 +1,81 @@ +--- +title: contact_flow_module +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_module + - 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 +--- +Gets an individual contact_flow_module resource + +## Overview + + + + + +
Namecontact_flow_module
TypeResource
Descriptioncontact_flow_module
Idawscc.connect.contact_flow_module
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance (ARN).
contact_flow_module_arnstringThe identifier of the contact flow module (ARN).
namestringThe name of the contact flow module.
contentstringThe content of the contact flow module in JSON format.
descriptionstringThe description of the contact flow module.
statestringThe state of the contact flow module.
statusstringThe status of the contact flow module.
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_flow_module resource, the following permissions are required: + +### Read +
+connect:DescribeContactFlowModule
+ +### Delete +
+connect:DeleteContactFlowModule,
+connect:UntagResource
+ +### Update +
+connect:UpdateContactFlowModuleMetadata,
+connect:UpdateContactFlowModuleContent,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +contact_flow_module_arn, +name, +content, +description, +state, +status, +tags +FROM awscc.connect.contact_flow_module +WHERE region = 'us-east-1' +AND data__Identifier = '<ContactFlowModuleArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/contact_flow_modules/index.md b/docs/awscc-docs/providers/awscc/connect/contact_flow_modules/index.md new file mode 100644 index 0000000000..d7c86a848f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/contact_flow_modules/index.md @@ -0,0 +1,59 @@ +--- +title: contact_flow_modules +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_modules + - 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 +--- +Retrieves a list of contact_flow_modules in a region + +## Overview + + + + + +
Namecontact_flow_modules
TypeResource
Descriptioncontact_flow_modules
Idawscc.connect.contact_flow_modules
+ +## Fields + + + + + +
NameDatatypeDescription
contact_flow_module_arnstringThe identifier of the contact flow module (ARN).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_flow_modules resource, the following permissions are required: + +### Create +
+connect:CreateContactFlowModule,
+connect:TagResource
+ +### List +
+connect:ListContactFlowModules
+ + +## Example +```sql +SELECT +region, +contact_flow_module_arn +FROM awscc.connect.contact_flow_modules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/contact_flows/index.md b/docs/awscc-docs/providers/awscc/connect/contact_flows/index.md new file mode 100644 index 0000000000..1c246e071f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/contact_flows/index.md @@ -0,0 +1,59 @@ +--- +title: contact_flows +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flows + - 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 +--- +Retrieves a list of contact_flows in a region + +## Overview + + + + + +
Namecontact_flows
TypeResource
Descriptioncontact_flows
Idawscc.connect.contact_flows
+ +## Fields + + + + + +
NameDatatypeDescription
contact_flow_arnstringThe identifier of the contact flow (ARN).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_flows resource, the following permissions are required: + +### Create +
+connect:CreateContactFlow,
+connect:TagResource
+ +### List +
+connect:ListContactFlows
+ + +## Example +```sql +SELECT +region, +contact_flow_arn +FROM awscc.connect.contact_flows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md b/docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md new file mode 100644 index 0000000000..58b1cb7b49 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md @@ -0,0 +1,84 @@ +--- +title: evaluation_form +hide_title: false +hide_table_of_contents: false +keywords: + - evaluation_form + - 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 +--- +Gets an individual evaluation_form resource + +## Overview + + + + + +
Nameevaluation_form
TypeResource
Descriptionevaluation_form
Idawscc.connect.evaluation_form
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
titlestringThe title of the evaluation form.
descriptionstringThe description of the evaluation form.
evaluation_form_arnstringThe Amazon Resource Name (ARN) for the evaluation form.
instance_arnstringThe Amazon Resource Name (ARN) of the instance.
itemsarrayThe list of evaluation form items.
scoring_strategyobjectThe scoring strategy.
statusstringThe status of the evaluation form.
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the evaluation_form resource, the following permissions are required: + +### Read +
+connect:DescribeEvaluationForm,
+connect:ListEvaluationFormVersions
+ +### Update +
+connect:UpdateEvaluationForm,
+connect:ListEvaluationFormVersions,
+connect:ActivateEvaluationForm,
+connect:DeactivateEvaluationForm,
+connect:TagResource,
+connect:UntagResource
+ +### Delete +
+connect:DeleteEvaluationForm,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +title, +description, +evaluation_form_arn, +instance_arn, +items, +scoring_strategy, +status, +tags +FROM awscc.connect.evaluation_form +WHERE region = 'us-east-1' +AND data__Identifier = '<EvaluationFormArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md b/docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md new file mode 100644 index 0000000000..be78600499 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md @@ -0,0 +1,60 @@ +--- +title: evaluation_forms +hide_title: false +hide_table_of_contents: false +keywords: + - evaluation_forms + - 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 +--- +Retrieves a list of evaluation_forms in a region + +## Overview + + + + + +
Nameevaluation_forms
TypeResource
Descriptionevaluation_forms
Idawscc.connect.evaluation_forms
+ +## Fields + + + + + +
NameDatatypeDescription
evaluation_form_arnstringThe Amazon Resource Name (ARN) for the evaluation form.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the evaluation_forms resource, the following permissions are required: + +### Create +
+connect:CreateEvaluationForm,
+connect:ActivateEvaluationForm,
+connect:TagResource
+ +### List +
+connect:ListEvaluationForms
+ + +## Example +```sql +SELECT +region, +evaluation_form_arn +FROM awscc.connect.evaluation_forms +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/hours_of_operation/index.md b/docs/awscc-docs/providers/awscc/connect/hours_of_operation/index.md new file mode 100644 index 0000000000..429536602f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/hours_of_operation/index.md @@ -0,0 +1,78 @@ +--- +title: hours_of_operation +hide_title: false +hide_table_of_contents: false +keywords: + - hours_of_operation + - 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 +--- +Gets an individual hours_of_operation resource + +## Overview + + + + + +
Namehours_of_operation
TypeResource
Descriptionhours_of_operation
Idawscc.connect.hours_of_operation
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the hours of operation.
descriptionstringThe description of the hours of operation.
time_zonestringThe time zone of the hours of operation.
configarrayConfiguration information for the hours of operation: day, start time, and end time.
hours_of_operation_arnstringThe Amazon Resource Name (ARN) for the hours of operation.
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hours_of_operation resource, the following permissions are required: + +### Read +
+connect:DescribeHoursOfOperation
+ +### Delete +
+connect:DeleteHoursOfOperation,
+connect:UntagResource
+ +### Update +
+connect:UpdateHoursOfOperation,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +name, +description, +time_zone, +config, +hours_of_operation_arn, +tags +FROM awscc.connect.hours_of_operation +WHERE region = 'us-east-1' +AND data__Identifier = '<HoursOfOperationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/hours_of_operations/index.md b/docs/awscc-docs/providers/awscc/connect/hours_of_operations/index.md new file mode 100644 index 0000000000..af70651391 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/hours_of_operations/index.md @@ -0,0 +1,59 @@ +--- +title: hours_of_operations +hide_title: false +hide_table_of_contents: false +keywords: + - hours_of_operations + - 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 +--- +Retrieves a list of hours_of_operations in a region + +## Overview + + + + + +
Namehours_of_operations
TypeResource
Descriptionhours_of_operations
Idawscc.connect.hours_of_operations
+ +## Fields + + + + + +
NameDatatypeDescription
hours_of_operation_arnstringThe Amazon Resource Name (ARN) for the hours of operation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hours_of_operations resource, the following permissions are required: + +### Create +
+connect:CreateHoursOfOperation,
+connect:TagResource
+ +### List +
+connect:ListHoursOfOperations
+ + +## Example +```sql +SELECT +region, +hours_of_operation_arn +FROM awscc.connect.hours_of_operations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/index.md b/docs/awscc-docs/providers/awscc/connect/index.md new file mode 100644 index 0000000000..f27ee3f05b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/index.md @@ -0,0 +1,81 @@ +--- +title: connect +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The connect service documentation. + +:::info Service Summary + +
+
+total resources: 44
+total selectable resources: 44
+total methods: 44
+
+
+ +::: + +## Resources +
+
+approved_origin
+approved_origins
+contact_flow
+contact_flow_module
+contact_flow_modules
+contact_flows
+evaluation_form
+evaluation_forms
+hours_of_operation
+hours_of_operations
+instance
+instance_storage_config
+instance_storage_configs
+instances
+integration_association
+integration_associations
+predefined_attribute
+predefined_attributes
+prompt
+prompts
+queue
+queues +
+
+quick_connect
+quick_connects
+routing_profile
+routing_profiles
+rule
+rules
+security_key
+security_keys
+security_profile
+security_profiles
+task_template
+task_templates
+traffic_distribution_group
+traffic_distribution_groups
+user
+user_hierarchy_group
+user_hierarchy_groups
+users
+view
+view_version
+view_versions
+views +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/connect/instance/index.md b/docs/awscc-docs/providers/awscc/connect/instance/index.md new file mode 100644 index 0000000000..6973fa7909 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/instance/index.md @@ -0,0 +1,93 @@ +--- +title: instance +hide_title: false +hide_table_of_contents: false +keywords: + - instance + - 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 +--- +Gets an individual instance resource + +## Overview + + + + + +
Nameinstance
TypeResource
Descriptioninstance
Idawscc.connect.instance
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringAn instanceId is automatically generated on creation and assigned as the unique identifier.
arnstringAn instanceArn is automatically generated on creation based on instanceId.
identity_management_typestringSpecifies the type of directory integration for new instance.
instance_aliasstringAlias of the new directory created as part of new instance creation.
created_timestringTimestamp of instance creation logged as part of instance creation.
service_rolestringService linked role created as part of instance creation.
instance_statusstringSpecifies the creation status of new instance.
directory_idstringExisting directoryId user wants to map to the new Connect instance.
attributesobjectThe attributes for the instance.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance resource, the following permissions are required: + +### Read +
+connect:DescribeInstance,
+connect:ListInstanceAttributes,
+ds:DescribeDirectories
+ +### Update +
+connect:ListInstanceAttributes,
+connect:UpdateInstanceAttribute,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy,
+connect:TagResource,
+connect:UntagResource
+ +### Delete +
+connect:DeleteInstance,
+connect:DescribeInstance,
+connect:UntagResource,
+ds:DeleteDirectory,
+ds:UnauthorizeApplication,
+ds:DescribeDirectories
+ + +## Example +```sql +SELECT +region, +id, +arn, +identity_management_type, +instance_alias, +created_time, +service_role, +instance_status, +directory_id, +attributes, +tags +FROM awscc.connect.instance +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/instance_storage_config/index.md b/docs/awscc-docs/providers/awscc/connect/instance_storage_config/index.md new file mode 100644 index 0000000000..0784b4ca51 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/instance_storage_config/index.md @@ -0,0 +1,97 @@ +--- +title: instance_storage_config +hide_title: false +hide_table_of_contents: false +keywords: + - instance_storage_config + - 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 +--- +Gets an individual instance_storage_config resource + +## Overview + + + + + +
Nameinstance_storage_config
TypeResource
Descriptioninstance_storage_config
Idawscc.connect.instance_storage_config
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringConnect Instance ID with which the storage config will be associated
resource_typestring
association_idstring
storage_typestring
s3_configobject
kinesis_video_stream_configobject
kinesis_stream_configobject
kinesis_firehose_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_storage_config resource, the following permissions are required: + +### Read +
+connect:DescribeInstanceStorageConfig,
+connect:ListInstanceStorageConfigs,
+connect:DescribeInstance,
+ds:DescribeDirectories,
+s3:GetBucketAcl,
+s3:GetBucketLocation
+ +### Update +
+connect:UpdateInstanceStorageConfig,
+ds:DescribeDirectories,
+s3:GetBucketAcl,
+s3:GetBucketLocation,
+kinesis:DescribeStream,
+iam:PutRolePolicy,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:RetireGrant,
+firehose:DescribeDeliveryStream
+ +### Delete +
+connect:DisassociateInstanceStorageConfig,
+connect:DescribeInstance,
+s3:GetBucketAcl,
+s3:GetBucketLocation,
+kms:RetireGrant
+ + +## Example +```sql +SELECT +region, +instance_arn, +resource_type, +association_id, +storage_type, +s3_config, +kinesis_video_stream_config, +kinesis_stream_config, +kinesis_firehose_config +FROM awscc.connect.instance_storage_config +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceArn>' +AND data__Identifier = '<AssociationId>' +AND data__Identifier = '<ResourceType>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/instance_storage_configs/index.md b/docs/awscc-docs/providers/awscc/connect/instance_storage_configs/index.md new file mode 100644 index 0000000000..ab540949d7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/instance_storage_configs/index.md @@ -0,0 +1,73 @@ +--- +title: instance_storage_configs +hide_title: false +hide_table_of_contents: false +keywords: + - instance_storage_configs + - 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 +--- +Retrieves a list of instance_storage_configs in a region + +## Overview + + + + + +
Nameinstance_storage_configs
TypeResource
Descriptioninstance_storage_configs
Idawscc.connect.instance_storage_configs
+ +## Fields + + + + + + + +
NameDatatypeDescription
instance_arnstringConnect Instance ID with which the storage config will be associated
association_idundefined
resource_typeundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_storage_configs resource, the following permissions are required: + +### Create +
+connect:AssociateInstanceStorageConfig,
+connect:DescribeInstance,
+ds:DescribeDirectories,
+s3:GetBucketAcl,
+s3:GetBucketLocation,
+iam:PutRolePolicy,
+kinesis:DescribeStream,
+kms:DescribeKey,
+kms:CreateGrant,
+firehose:DescribeDeliveryStream
+ +### List +
+connect:DescribeInstance,
+connect:ListInstanceStorageConfigs,
+ds:DescribeDirectories
+ + +## Example +```sql +SELECT +region, +instance_arn, +association_id, +resource_type +FROM awscc.connect.instance_storage_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/instances/index.md b/docs/awscc-docs/providers/awscc/connect/instances/index.md new file mode 100644 index 0000000000..59935f89c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/instances/index.md @@ -0,0 +1,73 @@ +--- +title: instances +hide_title: false +hide_table_of_contents: false +keywords: + - instances + - 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 +--- +Retrieves a list of instances in a region + +## Overview + + + + + +
Nameinstances
TypeResource
Descriptioninstances
Idawscc.connect.instances
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAn instanceArn is automatically generated on creation based on instanceId.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instances resource, the following permissions are required: + +### Create +
+connect:CreateInstance,
+connect:DescribeInstance,
+connect:UpdateInstanceAttribute,
+connect:TagResource,
+ds:CheckAlias,
+ds:CreateAlias,
+ds:AuthorizeApplication,
+ds:UnauthorizeApplication,
+ds:CreateIdentityPoolDirectory,
+ds:CreateDirectory,
+ds:DescribeDirectories,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy,
+logs:CreateLogGroup
+ +### List +
+connect:ListInstances,
+connect:ListInstanceAttributes,
+ds:DescribeDirectories
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.connect.instances +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/integration_association/index.md b/docs/awscc-docs/providers/awscc/connect/integration_association/index.md new file mode 100644 index 0000000000..aa30ae281b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/integration_association/index.md @@ -0,0 +1,90 @@ +--- +title: integration_association +hide_title: false +hide_table_of_contents: false +keywords: + - integration_association + - 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 +--- +Gets an individual integration_association resource + +## Overview + + + + + +
Nameintegration_association
TypeResource
Descriptionintegration_association
Idawscc.connect.integration_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
integration_association_idstring
instance_idstring
integration_arnstring
integration_typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integration_association resource, the following permissions are required: + +### Read +
+connect:ListBots,
+connect:ListLambdaFunctions,
+connect:ListIntegrationAssociations
+ +### Update +
+
+ +### Delete +
+connect:DescribeInstance,
+ds:DescribeDirectories,
+app-integrations:DeleteEventIntegrationAssociation,
+events:ListTargetsByRule,
+events:RemoveTargets,
+events:DeleteRule,
+connect:DisassociateBot,
+connect:DisassociateLambdaFunction,
+connect:DeleteIntegrationAssociation,
+connect:ListBots,
+connect:ListLambdaFunctions,
+connect:ListIntegrationAssociations,
+lex:DeleteResourcePolicy,
+lex:DeleteResourcePolicyStatement,
+lambda:RemovePermission,
+iam:GetRolePolicy,
+iam:DeleteRolePolicy,
+iam:PutRolePolicy
+ + +## Example +```sql +SELECT +region, +integration_association_id, +instance_id, +integration_arn, +integration_type +FROM awscc.connect.integration_association +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceId>' +AND data__Identifier = '<IntegrationType>' +AND data__Identifier = '<IntegrationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/integration_associations/index.md b/docs/awscc-docs/providers/awscc/connect/integration_associations/index.md new file mode 100644 index 0000000000..30c010dde0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/integration_associations/index.md @@ -0,0 +1,92 @@ +--- +title: integration_associations +hide_title: false +hide_table_of_contents: false +keywords: + - integration_associations + - 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 +--- +Retrieves a list of integration_associations in a region + +## Overview + + + + + +
Nameintegration_associations
TypeResource
Descriptionintegration_associations
Idawscc.connect.integration_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
instance_idundefined
integration_typeundefined
integration_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integration_associations resource, the following permissions are required: + +### Create +
+connect:DescribeInstance,
+ds:DescribeDirectories,
+app-integrations:CreateEventIntegrationAssociation,
+mobiletargeting:GetApp,
+cases:GetDomain,
+wisdom:GetAssistant,
+wisdom:GetKnowledgeBase,
+wisdom:TagResource,
+voiceid:DescribeDomain,
+events:PutTargets,
+events:PutRule,
+connect:AssociateBot,
+connect:AssociateLambdaFunction,
+connect:CreateIntegrationAssociation,
+connect:ListBots,
+connect:ListLambdaFunctions,
+connect:ListIntegrationAssociations,
+lambda:addPermission,
+lex:GetBot,
+lex:DescribeBotAlias,
+lex:CreateResourcePolicy,
+lex:UpdateResourcePolicy,
+lex:CreateResourcePolicyStatement,
+lambda:AddPermission,
+app-integrations:GetApplication,
+iam:AttachRolePolicy,
+iam:CreateServiceLinkedRole,
+iam:GetRolePolicy,
+iam:PutRolePolicy
+ +### List +
+connect:ListBots,
+connect:ListLambdaFunctions,
+connect:ListIntegrationAssociations
+ + +## Example +```sql +SELECT +region, +instance_id, +integration_type, +integration_arn +FROM awscc.connect.integration_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md b/docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md new file mode 100644 index 0000000000..a13968a7d6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md @@ -0,0 +1,68 @@ +--- +title: predefined_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - predefined_attribute + - 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 +--- +Gets an individual predefined_attribute resource + +## Overview + + + + + +
Namepredefined_attribute
TypeResource
Descriptionpredefined_attribute
Idawscc.connect.predefined_attribute
+ +## Fields + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the predefined attribute.
valuesobjectThe values of a predefined attribute.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the predefined_attribute resource, the following permissions are required: + +### Read +
+connect:DescribePredefinedAttribute
+ +### Delete +
+connect:DeletePredefinedAttribute
+ +### Update +
+connect:UpdatePredefinedAttribute
+ + +## Example +```sql +SELECT +region, +instance_arn, +name, +values +FROM awscc.connect.predefined_attribute +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceArn>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md b/docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md new file mode 100644 index 0000000000..fd3a14e3af --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md @@ -0,0 +1,60 @@ +--- +title: predefined_attributes +hide_title: false +hide_table_of_contents: false +keywords: + - predefined_attributes + - 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 +--- +Retrieves a list of predefined_attributes in a region + +## Overview + + + + + +
Namepredefined_attributes
TypeResource
Descriptionpredefined_attributes
Idawscc.connect.predefined_attributes
+ +## Fields + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the predefined attribute.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the predefined_attributes resource, the following permissions are required: + +### Create +
+connect:CreatePredefinedAttribute
+ +### List +
+connect:ListPredefinedAttributes
+ + +## Example +```sql +SELECT +region, +instance_arn, +name +FROM awscc.connect.predefined_attributes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/prompt/index.md b/docs/awscc-docs/providers/awscc/connect/prompt/index.md new file mode 100644 index 0000000000..427799cf42 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/prompt/index.md @@ -0,0 +1,75 @@ +--- +title: prompt +hide_title: false +hide_table_of_contents: false +keywords: + - prompt + - 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 +--- +Gets an individual prompt resource + +## Overview + + + + + +
Nameprompt
TypeResource
Descriptionprompt
Idawscc.connect.prompt
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the prompt.
descriptionstringThe description of the prompt.
s3_uristringS3 URI of the customer's audio file for creating prompts resource..
prompt_arnstringThe Amazon Resource Name (ARN) for the prompt.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the prompt resource, the following permissions are required: + +### Read +
+connect:DescribePrompt
+ +### Update +
+connect:UpdatePrompt,
+connect:TagResource,
+connect:UntagResource
+ +### Delete +
+connect:DeletePrompt
+ + +## Example +```sql +SELECT +region, +instance_arn, +name, +description, +s3_uri, +prompt_arn, +tags +FROM awscc.connect.prompt +WHERE region = 'us-east-1' +AND data__Identifier = '<PromptArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/prompts/index.md b/docs/awscc-docs/providers/awscc/connect/prompts/index.md new file mode 100644 index 0000000000..b9880dd92b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/prompts/index.md @@ -0,0 +1,62 @@ +--- +title: prompts +hide_title: false +hide_table_of_contents: false +keywords: + - prompts + - 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 +--- +Retrieves a list of prompts in a region + +## Overview + + + + + +
Nameprompts
TypeResource
Descriptionprompts
Idawscc.connect.prompts
+ +## Fields + + + + + +
NameDatatypeDescription
prompt_arnstringThe Amazon Resource Name (ARN) for the prompt.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the prompts resource, the following permissions are required: + +### Create +
+connect:CreatePrompt,
+connect:TagResource,
+s3:GetObject,
+kms:Decrypt,
+s3:GetObjectAcl
+ +### List +
+connect:ListPrompts
+ + +## Example +```sql +SELECT +region, +prompt_arn +FROM awscc.connect.prompts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/queue/index.md b/docs/awscc-docs/providers/awscc/connect/queue/index.md new file mode 100644 index 0000000000..45d1eb22ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/queue/index.md @@ -0,0 +1,93 @@ +--- +title: queue +hide_title: false +hide_table_of_contents: false +keywords: + - queue + - 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 +--- +Gets an individual queue resource + +## Overview + + + + + +
Namequeue
TypeResource
Descriptionqueue
Idawscc.connect.queue
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
descriptionstringThe description of the queue.
hours_of_operation_arnstringThe identifier for the hours of operation.
max_contactsintegerThe maximum number of contacts that can be in the queue before it is considered full.
namestringThe name of the queue.
outbound_caller_configobjectThe outbound caller ID name, number, and outbound whisper flow.
queue_arnstringThe Amazon Resource Name (ARN) for the queue.
statusstringThe status of the queue.
quick_connect_arnsarrayThe quick connects available to agents who are working the queue.
tagsarrayAn array of key-value pairs to apply to this resource.
typestringThe type of queue.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queue resource, the following permissions are required: + +### Read +
+connect:DescribeQueue,
+connect:ListQueueQuickConnects
+ +### Delete +
+connect:DeleteQueue,
+connect:UntagResource
+ +### Update +
+connect:UpdateQueueHoursOfOperation,
+connect:UpdateQueueMaxContacts,
+connect:UpdateQueueName,
+connect:UpdateQueueOutboundCallerConfig,
+connect:UpdateQueueStatus,
+connect:AssociateQueueQuickConnects,
+connect:DisassociateQueueQuickConnects,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +description, +hours_of_operation_arn, +max_contacts, +name, +outbound_caller_config, +queue_arn, +status, +quick_connect_arns, +tags, +type +FROM awscc.connect.queue +WHERE region = 'us-east-1' +AND data__Identifier = '<QueueArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/queues/index.md b/docs/awscc-docs/providers/awscc/connect/queues/index.md new file mode 100644 index 0000000000..5cbc2daacf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/queues/index.md @@ -0,0 +1,60 @@ +--- +title: queues +hide_title: false +hide_table_of_contents: false +keywords: + - queues + - 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 +--- +Retrieves a list of queues in a region + +## Overview + + + + + +
Namequeues
TypeResource
Descriptionqueues
Idawscc.connect.queues
+ +## Fields + + + + + +
NameDatatypeDescription
queue_arnstringThe Amazon Resource Name (ARN) for the queue.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queues resource, the following permissions are required: + +### Create +
+connect:CreateQueue,
+connect:TagResource
+ +### List +
+connect:ListQueues,
+connect:ListQueueQuickConnects
+ + +## Example +```sql +SELECT +region, +queue_arn +FROM awscc.connect.queues +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/quick_connect/index.md b/docs/awscc-docs/providers/awscc/connect/quick_connect/index.md new file mode 100644 index 0000000000..fb503ed312 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/quick_connect/index.md @@ -0,0 +1,79 @@ +--- +title: quick_connect +hide_title: false +hide_table_of_contents: false +keywords: + - quick_connect + - 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 +--- +Gets an individual quick_connect resource + +## Overview + + + + + +
Namequick_connect
TypeResource
Descriptionquick_connect
Idawscc.connect.quick_connect
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the quick connect.
descriptionstringThe description of the quick connect.
quick_connect_configobjectConfiguration settings for the quick connect.
quick_connect_arnstringThe Amazon Resource Name (ARN) for the quick connect.
tagsarrayOne or more tags.
quick_connect_typestringThe 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).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the quick_connect resource, the following permissions are required: + +### Read +
+connect:DescribeQuickConnect
+ +### Delete +
+connect:DeleteQuickConnect,
+connect:UntagResource
+ +### Update +
+connect:UpdateQuickConnectName,
+connect:UpdateQuickConnectConfig,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +name, +description, +quick_connect_config, +quick_connect_arn, +tags, +quick_connect_type +FROM awscc.connect.quick_connect +WHERE region = 'us-east-1' +AND data__Identifier = '<QuickConnectArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/quick_connects/index.md b/docs/awscc-docs/providers/awscc/connect/quick_connects/index.md new file mode 100644 index 0000000000..97870a1a90 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/quick_connects/index.md @@ -0,0 +1,59 @@ +--- +title: quick_connects +hide_title: false +hide_table_of_contents: false +keywords: + - quick_connects + - 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 +--- +Retrieves a list of quick_connects in a region + +## Overview + + + + + +
Namequick_connects
TypeResource
Descriptionquick_connects
Idawscc.connect.quick_connects
+ +## Fields + + + + + +
NameDatatypeDescription
quick_connect_arnstringThe Amazon Resource Name (ARN) for the quick connect.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the quick_connects resource, the following permissions are required: + +### Create +
+connect:CreateQuickConnect,
+connect:TagResource
+ +### List +
+connect:ListQuickConnects
+ + +## Example +```sql +SELECT +region, +quick_connect_arn +FROM awscc.connect.quick_connects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/routing_profile/index.md b/docs/awscc-docs/providers/awscc/connect/routing_profile/index.md new file mode 100644 index 0000000000..13d7ba2f28 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/routing_profile/index.md @@ -0,0 +1,90 @@ +--- +title: routing_profile +hide_title: false +hide_table_of_contents: false +keywords: + - routing_profile + - 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 +--- +Gets an individual routing_profile resource + +## Overview + + + + + +
Namerouting_profile
TypeResource
Descriptionrouting_profile
Idawscc.connect.routing_profile
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the routing profile.
descriptionstringThe description of the routing profile.
media_concurrenciesarrayThe channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
default_outbound_queue_arnstringThe identifier of the default outbound queue for this routing profile.
routing_profile_arnstringThe Amazon Resource Name (ARN) of the routing profile.
queue_configsarrayThe queues to associate with this routing profile.
tagsarrayAn array of key-value pairs to apply to this resource.
agent_availability_timerstringWhether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the routing_profile resource, the following permissions are required: + +### Read +
+connect:DescribeRoutingProfile,
+connect:ListRoutingProfileQueues
+ +### Delete +
+connect:DeleteRoutingProfile,
+connect:UntagResource
+ +### Update +
+connect:AssociateRoutingProfileQueues,
+connect:DisassociateRoutingProfileQueues,
+connect:UpdateRoutingProfileConcurrency,
+connect:UpdateRoutingProfileName,
+connect:UpdateRoutingProfileDefaultOutboundQueue,
+connect:UpdateRoutingProfileQueues,
+connect:TagResource,
+connect:UntagResource,
+connect:ListRoutingProfileQueues,
+connect:UpdateRoutingProfileAgentAvailabilityTimer
+ + +## Example +```sql +SELECT +region, +instance_arn, +name, +description, +media_concurrencies, +default_outbound_queue_arn, +routing_profile_arn, +queue_configs, +tags, +agent_availability_timer +FROM awscc.connect.routing_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<RoutingProfileArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md b/docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md new file mode 100644 index 0000000000..b6bde0fd3d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md @@ -0,0 +1,60 @@ +--- +title: routing_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - routing_profiles + - 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 +--- +Retrieves a list of routing_profiles in a region + +## Overview + + + + + +
Namerouting_profiles
TypeResource
Descriptionrouting_profiles
Idawscc.connect.routing_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
routing_profile_arnstringThe Amazon Resource Name (ARN) of the routing profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the routing_profiles resource, the following permissions are required: + +### Create +
+connect:CreateRoutingProfile,
+connect:TagResource
+ +### List +
+connect:ListRoutingProfiles,
+connect:ListRoutingProfileQueues
+ + +## Example +```sql +SELECT +region, +routing_profile_arn +FROM awscc.connect.routing_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/rule/index.md b/docs/awscc-docs/providers/awscc/connect/rule/index.md new file mode 100644 index 0000000000..d81b039213 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/rule/index.md @@ -0,0 +1,83 @@ +--- +title: rule +hide_title: false +hide_table_of_contents: false +keywords: + - rule + - 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 +--- +Gets an individual rule resource + +## Overview + + + + + +
Namerule
TypeResource
Descriptionrule
Idawscc.connect.rule
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the rule.
rule_arnstringThe Amazon Resource Name (ARN) of the rule.
instance_arnstringThe Amazon Resource Name (ARN) of the instance.
trigger_event_sourceobjectThe event source that triggers the rule.
functionstringThe conditions of a rule.
actionsobjectThe list of actions that will be executed when a rule is triggered.
publish_statusstringThe publish status of a rule, either draft or published.
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule resource, the following permissions are required: + +### Read +
+connect:DescribeRule
+ +### Delete +
+connect:DeleteRule,
+connect:UntagResource
+ +### Update +
+connect:UpdateRule,
+cases:GetTemplate,
+cases:ListFields,
+cases:ListFieldOptions,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +name, +rule_arn, +instance_arn, +trigger_event_source, +function, +actions, +publish_status, +tags +FROM awscc.connect.rule +WHERE region = 'us-east-1' +AND data__Identifier = '<RuleArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/rules/index.md b/docs/awscc-docs/providers/awscc/connect/rules/index.md new file mode 100644 index 0000000000..a1796bacd8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/rules/index.md @@ -0,0 +1,57 @@ +--- +title: rules +hide_title: false +hide_table_of_contents: false +keywords: + - rules + - 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 +--- +Retrieves a list of rules in a region + +## Overview + + + + + +
Namerules
TypeResource
Descriptionrules
Idawscc.connect.rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_arnstringThe Amazon Resource Name (ARN) of the rule.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Create +
+connect:CreateRule,
+cases:GetTemplate,
+cases:ListFields,
+cases:ListFieldOptions
+ + +## Example +```sql +SELECT +region, +rule_arn +FROM awscc.connect.rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/security_key/index.md b/docs/awscc-docs/providers/awscc/connect/security_key/index.md new file mode 100644 index 0000000000..8a3bba7a49 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/security_key/index.md @@ -0,0 +1,68 @@ +--- +title: security_key +hide_title: false +hide_table_of_contents: false +keywords: + - security_key + - 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 +--- +Gets an individual security_key resource + +## Overview + + + + + +
Namesecurity_key
TypeResource
Descriptionsecurity_key
Idawscc.connect.security_key
+ +## Fields + + + + + + + +
NameDatatypeDescription
keystring
instance_idstring
association_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_key resource, the following permissions are required: + +### Read +
+connect:ListSecurityKeys
+ +### Update +
+
+ +### Delete +
+connect:DisassociateSecurityKey
+ + +## Example +```sql +SELECT +region, +key, +instance_id, +association_id +FROM awscc.connect.security_key +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceId>' +AND data__Identifier = '<AssociationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/security_keys/index.md b/docs/awscc-docs/providers/awscc/connect/security_keys/index.md new file mode 100644 index 0000000000..74af0ea030 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/security_keys/index.md @@ -0,0 +1,60 @@ +--- +title: security_keys +hide_title: false +hide_table_of_contents: false +keywords: + - security_keys + - 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 +--- +Retrieves a list of security_keys in a region + +## Overview + + + + + +
Namesecurity_keys
TypeResource
Descriptionsecurity_keys
Idawscc.connect.security_keys
+ +## Fields + + + + + + +
NameDatatypeDescription
instance_idundefined
association_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_keys resource, the following permissions are required: + +### Create +
+connect:AssociateSecurityKey
+ +### List +
+connect:ListSecurityKeys
+ + +## Example +```sql +SELECT +region, +instance_id, +association_id +FROM awscc.connect.security_keys +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/security_profile/index.md b/docs/awscc-docs/providers/awscc/connect/security_profile/index.md new file mode 100644 index 0000000000..77a5cb5ccf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/security_profile/index.md @@ -0,0 +1,81 @@ +--- +title: security_profile +hide_title: false +hide_table_of_contents: false +keywords: + - security_profile + - 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 +--- +Gets an individual security_profile resource + +## Overview + + + + + +
Namesecurity_profile
TypeResource
Descriptionsecurity_profile
Idawscc.connect.security_profile
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
allowed_access_control_tagsarrayThe list of tags that a security profile uses to restrict access to resources in Amazon Connect.
descriptionstringThe description of the security profile.
instance_arnstringThe identifier of the Amazon Connect instance.
permissionsarrayPermissions assigned to the security profile.
security_profile_arnstringThe Amazon Resource Name (ARN) for the security profile.
security_profile_namestringThe name of the security profile.
tag_restricted_resourcesarrayThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
tagsarrayThe tags used to organize, track, or control access for this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_profile resource, the following permissions are required: + +### Read +
+connect:DescribeSecurityProfile,
+connect:ListSecurityProfilePermissions
+ +### Update +
+connect:TagResource,
+connect:UpdateSecurityProfile,
+connect:UntagResource
+ +### Delete +
+connect:DeleteSecurityProfile,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +allowed_access_control_tags, +description, +instance_arn, +permissions, +security_profile_arn, +security_profile_name, +tag_restricted_resources, +tags +FROM awscc.connect.security_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<SecurityProfileArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/security_profiles/index.md b/docs/awscc-docs/providers/awscc/connect/security_profiles/index.md new file mode 100644 index 0000000000..5e020202ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/security_profiles/index.md @@ -0,0 +1,59 @@ +--- +title: security_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - security_profiles + - 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 +--- +Retrieves a list of security_profiles in a region + +## Overview + + + + + +
Namesecurity_profiles
TypeResource
Descriptionsecurity_profiles
Idawscc.connect.security_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
security_profile_arnstringThe Amazon Resource Name (ARN) for the security profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_profiles resource, the following permissions are required: + +### Create +
+connect:CreateSecurityProfile,
+connect:TagResource
+ +### List +
+connect:ListSecurityProfiles
+ + +## Example +```sql +SELECT +region, +security_profile_arn +FROM awscc.connect.security_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/task_template/index.md b/docs/awscc-docs/providers/awscc/connect/task_template/index.md new file mode 100644 index 0000000000..a86ddedc0a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/task_template/index.md @@ -0,0 +1,87 @@ +--- +title: task_template +hide_title: false +hide_table_of_contents: false +keywords: + - task_template + - 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 +--- +Gets an individual task_template resource + +## Overview + + + + + +
Nametask_template
TypeResource
Descriptiontask_template
Idawscc.connect.task_template
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe identifier (arn) of the task template.
instance_arnstringThe identifier (arn) of the instance.
namestringThe name of the task template.
descriptionstringThe description of the task template.
contact_flow_arnstringThe identifier of the contact flow.
constraintsobjectThe constraints for the task template
defaultsarray
fieldsarrayThe list of task template's fields
statusstring
client_tokenstring
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_template resource, the following permissions are required: + +### Read +
+connect:GetTaskTemplate
+ +### Update +
+connect:UpdateTaskTemplate,
+connect:TagResource,
+connect:UntagResource
+ +### Delete +
+connect:DeleteTaskTemplate,
+connect:UntagResource,
+connect:GetTaskTemplate
+ + +## Example +```sql +SELECT +region, +arn, +instance_arn, +name, +description, +contact_flow_arn, +constraints, +defaults, +fields, +status, +client_token, +tags +FROM awscc.connect.task_template +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/task_templates/index.md b/docs/awscc-docs/providers/awscc/connect/task_templates/index.md new file mode 100644 index 0000000000..377851da8b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/task_templates/index.md @@ -0,0 +1,59 @@ +--- +title: task_templates +hide_title: false +hide_table_of_contents: false +keywords: + - task_templates + - 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 +--- +Retrieves a list of task_templates in a region + +## Overview + + + + + +
Nametask_templates
TypeResource
Descriptiontask_templates
Idawscc.connect.task_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe identifier (arn) of the task template.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_templates resource, the following permissions are required: + +### Create +
+connect:CreateTaskTemplate,
+connect:TagResource
+ +### List +
+connect:ListTaskTemplates
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.connect.task_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/traffic_distribution_group/index.md b/docs/awscc-docs/providers/awscc/connect/traffic_distribution_group/index.md new file mode 100644 index 0000000000..de81487f57 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/traffic_distribution_group/index.md @@ -0,0 +1,78 @@ +--- +title: traffic_distribution_group +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_distribution_group + - 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 +--- +Gets an individual traffic_distribution_group resource + +## Overview + + + + + +
Nametraffic_distribution_group
TypeResource
Descriptiontraffic_distribution_group
Idawscc.connect.traffic_distribution_group
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance that has been replicated.
traffic_distribution_group_arnstringThe identifier of the traffic distribution group.
descriptionstringA description for the traffic distribution group.
namestringThe name for the traffic distribution group.
statusstringThe status of the traffic distribution group.
tagsarrayOne or more tags.
is_defaultbooleanIf this is the default traffic distribution group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the traffic_distribution_group resource, the following permissions are required: + +### Read +
+connect:DescribeTrafficDistributionGroup
+ +### Update +
+connect:TagResource,
+connect:UntagResource
+ +### Delete +
+connect:DeleteTrafficDistributionGroup,
+connect:DescribeTrafficDistributionGroup,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +traffic_distribution_group_arn, +description, +name, +status, +tags, +is_default +FROM awscc.connect.traffic_distribution_group +WHERE region = 'us-east-1' +AND data__Identifier = '<TrafficDistributionGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/traffic_distribution_groups/index.md b/docs/awscc-docs/providers/awscc/connect/traffic_distribution_groups/index.md new file mode 100644 index 0000000000..cf7ef7ae12 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/traffic_distribution_groups/index.md @@ -0,0 +1,60 @@ +--- +title: traffic_distribution_groups +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_distribution_groups + - 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 +--- +Retrieves a list of traffic_distribution_groups in a region + +## Overview + + + + + +
Nametraffic_distribution_groups
TypeResource
Descriptiontraffic_distribution_groups
Idawscc.connect.traffic_distribution_groups
+ +## Fields + + + + + +
NameDatatypeDescription
traffic_distribution_group_arnstringThe identifier of the traffic distribution group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the traffic_distribution_groups resource, the following permissions are required: + +### Create +
+connect:CreateTrafficDistributionGroup,
+connect:DescribeTrafficDistributionGroup,
+connect:TagResource
+ +### List +
+connect:ListTrafficDistributionGroups
+ + +## Example +```sql +SELECT +region, +traffic_distribution_group_arn +FROM awscc.connect.traffic_distribution_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/user/index.md b/docs/awscc-docs/providers/awscc/connect/user/index.md new file mode 100644 index 0000000000..f86d513a2b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/user/index.md @@ -0,0 +1,96 @@ +--- +title: user +hide_title: false +hide_table_of_contents: false +keywords: + - user + - 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 +--- +Gets an individual user resource + +## Overview + + + + + +
Nameuser
TypeResource
Descriptionuser
Idawscc.connect.user
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
directory_user_idstringThe identifier of the user account in the directory used for identity management.
hierarchy_group_arnstringThe identifier of the hierarchy group for the user.
usernamestringThe user name for the account.
passwordstringThe 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.
routing_profile_arnstringThe identifier of the routing profile for the user.
identity_infoobjectThe information about the identity of the user.
phone_configobjectThe phone settings for the user.
security_profile_arnsarrayOne or more security profile arns for the user
user_arnstringThe Amazon Resource Name (ARN) for the user.
tagsarrayOne or more tags.
user_proficienciesarrayOne or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +
+connect:DescribeUser,
+connect:ListUserProficiencies
+ +### Delete +
+connect:DeleteUser,
+connect:UntagResource
+ +### Update +
+connect:UpdateUserIdentityInfo,
+connect:UpdateUserPhoneConfig,
+connect:UpdateUserRoutingProfile,
+connect:UpdateUserSecurityProfiles,
+connect:UpdateUserHierarchy,
+connect:TagResource,
+connect:UntagResource,
+connect:AssociateUserProficiencies,
+connect:DisassociateUserProficiencies,
+connect:UpdateUserProficiencies
+ + +## Example +```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, +tags, +user_proficiencies +FROM awscc.connect.user +WHERE region = 'us-east-1' +AND data__Identifier = '<UserArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/user_hierarchy_group/index.md b/docs/awscc-docs/providers/awscc/connect/user_hierarchy_group/index.md new file mode 100644 index 0000000000..894ddfdb8e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/user_hierarchy_group/index.md @@ -0,0 +1,74 @@ +--- +title: user_hierarchy_group +hide_title: false +hide_table_of_contents: false +keywords: + - user_hierarchy_group + - 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 +--- +Gets an individual user_hierarchy_group resource + +## Overview + + + + + +
Nameuser_hierarchy_group
TypeResource
Descriptionuser_hierarchy_group
Idawscc.connect.user_hierarchy_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
user_hierarchy_group_arnstringThe Amazon Resource Name (ARN) for the user hierarchy group.
parent_group_arnstringThe Amazon Resource Name (ARN) for the parent user hierarchy group.
namestringThe name of the user hierarchy group.
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_hierarchy_group resource, the following permissions are required: + +### Read +
+connect:DescribeUserHierarchyGroup
+ +### Delete +
+connect:DeleteUserHierarchyGroup,
+connect:UntagResource
+ +### Update +
+connect:UpdateUserHierarchyGroupName,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +user_hierarchy_group_arn, +parent_group_arn, +name, +tags +FROM awscc.connect.user_hierarchy_group +WHERE region = 'us-east-1' +AND data__Identifier = '<UserHierarchyGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/user_hierarchy_groups/index.md b/docs/awscc-docs/providers/awscc/connect/user_hierarchy_groups/index.md new file mode 100644 index 0000000000..a0baec950d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/user_hierarchy_groups/index.md @@ -0,0 +1,59 @@ +--- +title: user_hierarchy_groups +hide_title: false +hide_table_of_contents: false +keywords: + - user_hierarchy_groups + - 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 +--- +Retrieves a list of user_hierarchy_groups in a region + +## Overview + + + + + +
Nameuser_hierarchy_groups
TypeResource
Descriptionuser_hierarchy_groups
Idawscc.connect.user_hierarchy_groups
+ +## Fields + + + + + +
NameDatatypeDescription
user_hierarchy_group_arnundefinedThe Amazon Resource Name (ARN) for the user hierarchy group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_hierarchy_groups resource, the following permissions are required: + +### Create +
+connect:CreateUserHierarchyGroup,
+connect:TagResource
+ +### List +
+connect:ListUserHierarchyGroups
+ + +## Example +```sql +SELECT +region, +user_hierarchy_group_arn +FROM awscc.connect.user_hierarchy_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/users/index.md b/docs/awscc-docs/providers/awscc/connect/users/index.md new file mode 100644 index 0000000000..94660cedb5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/users/index.md @@ -0,0 +1,60 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - 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 +--- +Retrieves a list of users in a region + +## Overview + + + + + +
Nameusers
TypeResource
Descriptionusers
Idawscc.connect.users
+ +## Fields + + + + + +
NameDatatypeDescription
user_arnstringThe Amazon Resource Name (ARN) for the user.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +
+connect:CreateUser,
+connect:TagResource,
+connect:AssociateUserProficiencies
+ +### List +
+connect:ListUsers
+ + +## Example +```sql +SELECT +region, +user_arn +FROM awscc.connect.users +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/view/index.md b/docs/awscc-docs/providers/awscc/connect/view/index.md new file mode 100644 index 0000000000..22c2db24fb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/view/index.md @@ -0,0 +1,83 @@ +--- +title: view +hide_title: false +hide_table_of_contents: false +keywords: + - view + - 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 +--- +Gets an individual view resource + +## Overview + + + + + +
Nameview
TypeResource
Descriptionview
Idawscc.connect.view
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe Amazon Resource Name (ARN) of the instance.
view_arnstringThe Amazon Resource Name (ARN) of the view.
view_idstringThe view id of the view.
namestringThe name of the view.
descriptionstringThe description of the view.
templateobjectThe template of the view as JSON.
actionsarrayThe actions of the view in an array.
view_content_sha256stringThe view content hash.
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the view resource, the following permissions are required: + +### Read +
+connect:DescribeView
+ +### Delete +
+connect:DeleteView,
+connect:UntagResource
+ +### Update +
+connect:UpdateViewMetadata,
+connect:UpdateViewContent,
+connect:TagResource,
+connect:UntagResource
+ + +## Example +```sql +SELECT +region, +instance_arn, +view_arn, +view_id, +name, +description, +template, +actions, +view_content_sha256, +tags +FROM awscc.connect.view +WHERE region = 'us-east-1' +AND data__Identifier = '<ViewArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/view_version/index.md b/docs/awscc-docs/providers/awscc/connect/view_version/index.md new file mode 100644 index 0000000000..7a54dee983 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/view_version/index.md @@ -0,0 +1,71 @@ +--- +title: view_version +hide_title: false +hide_table_of_contents: false +keywords: + - view_version + - 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 +--- +Gets an individual view_version resource + +## Overview + + + + + +
Nameview_version
TypeResource
Descriptionview_version
Idawscc.connect.view_version
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
view_arnstringThe Amazon Resource Name (ARN) of the view for which a version is being created.
view_version_arnstringThe Amazon Resource Name (ARN) of the created view version.
version_descriptionstringThe description for the view version.
view_content_sha256stringThe view content hash to be checked.
versionintegerThe version of the view.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the view_version resource, the following permissions are required: + +### Read +
+connect:DescribeView
+ +### Update +
+
+ +### Delete +
+connect:DeleteViewVersion
+ + +## Example +```sql +SELECT +region, +view_arn, +view_version_arn, +version_description, +view_content_sha256, +version +FROM awscc.connect.view_version +WHERE region = 'us-east-1' +AND data__Identifier = '<ViewVersionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/view_versions/index.md b/docs/awscc-docs/providers/awscc/connect/view_versions/index.md new file mode 100644 index 0000000000..7cc03e6d48 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/view_versions/index.md @@ -0,0 +1,58 @@ +--- +title: view_versions +hide_title: false +hide_table_of_contents: false +keywords: + - view_versions + - 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 +--- +Retrieves a list of view_versions in a region + +## Overview + + + + + +
Nameview_versions
TypeResource
Descriptionview_versions
Idawscc.connect.view_versions
+ +## Fields + + + + + +
NameDatatypeDescription
view_version_arnstringThe Amazon Resource Name (ARN) of the created view version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the view_versions resource, the following permissions are required: + +### Create +
+connect:CreateViewVersion
+ +### List +
+connect:ListViewVersions
+ + +## Example +```sql +SELECT +region, +view_version_arn +FROM awscc.connect.view_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connect/views/index.md b/docs/awscc-docs/providers/awscc/connect/views/index.md new file mode 100644 index 0000000000..48cf7de0b4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connect/views/index.md @@ -0,0 +1,59 @@ +--- +title: views +hide_title: false +hide_table_of_contents: false +keywords: + - views + - 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 +--- +Retrieves a list of views in a region + +## Overview + + + + + +
Nameviews
TypeResource
Descriptionviews
Idawscc.connect.views
+ +## Fields + + + + + +
NameDatatypeDescription
view_arnstringThe Amazon Resource Name (ARN) of the view.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the views resource, the following permissions are required: + +### Create +
+connect:CreateView,
+connect:TagResource
+ +### List +
+connect:ListViews
+ + +## Example +```sql +SELECT +region, +view_arn +FROM awscc.connect.views +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md b/docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md new file mode 100644 index 0000000000..7eb3259297 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md @@ -0,0 +1,78 @@ +--- +title: campaign +hide_title: false +hide_table_of_contents: false +keywords: + - campaign + - 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 +--- +Gets an individual campaign resource + +## Overview + + + + + +
Namecampaign
TypeResource
Descriptioncampaign
Idawscc.connectcampaigns.campaign
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
connect_instance_arnstringAmazon Connect Instance Arn
dialer_configobject
arnstringAmazon Connect Campaign Arn
namestringAmazon Connect Campaign Name
outbound_call_configobject
tagsarrayOne or more tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the campaign resource, the following permissions are required: + +### Read +
+connect-campaigns:DescribeCampaign
+ +### Delete +
+connect-campaigns:DeleteCampaign
+ +### Update +
+connect-campaigns:UpdateCampaignDialerConfig,
+connect-campaigns:UpdateCampaignName,
+connect-campaigns:UpdateCampaignOutboundCallConfig,
+connect-campaigns:TagResource,
+connect-campaigns:UntagResource,
+connect-campaigns:DescribeCampaign
+ + +## Example +```sql +SELECT +region, +connect_instance_arn, +dialer_config, +arn, +name, +outbound_call_config, +tags +FROM awscc.connectcampaigns.campaign +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md b/docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md new file mode 100644 index 0000000000..bd711d7827 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md @@ -0,0 +1,63 @@ +--- +title: campaigns +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns + - 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 +--- +Retrieves a list of campaigns in a region + +## Overview + + + + + +
Namecampaigns
TypeResource
Descriptioncampaigns
Idawscc.connectcampaigns.campaigns
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Connect Campaign Arn
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the campaigns resource, the following permissions are required: + +### Create +
+connect-campaigns:CreateCampaign,
+connect-campaigns:DescribeCampaign,
+connect-campaigns:TagResource,
+connect:DescribeContactFlow,
+connect:DescribeInstance,
+connect:DescribeQueue
+ +### List +
+connect-campaigns:ListCampaigns
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.connectcampaigns.campaigns +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/connectcampaigns/index.md b/docs/awscc-docs/providers/awscc/connectcampaigns/index.md new file mode 100644 index 0000000000..5414579fb4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/connectcampaigns/index.md @@ -0,0 +1,39 @@ +--- +title: connectcampaigns +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The connectcampaigns service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+campaign +
+
+campaigns +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/controltower/enabled_baseline/index.md b/docs/awscc-docs/providers/awscc/controltower/enabled_baseline/index.md new file mode 100644 index 0000000000..72318fe6f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/controltower/enabled_baseline/index.md @@ -0,0 +1,124 @@ +--- +title: enabled_baseline +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_baseline + - 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 +--- +Gets an individual enabled_baseline resource + +## Overview + + + + + +
Nameenabled_baseline
TypeResource
Descriptionenabled_baseline
Idawscc.controltower.enabled_baseline
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
baseline_identifierstring
baseline_versionstring
enabled_baseline_identifierstring
target_identifierstring
parametersarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the enabled_baseline resource, the following permissions are required: + +### Read +
+controltower:GetEnabledBaseline,
+controltower:ListEnabledBaselines,
+controltower:ListTagsForResource
+ +### Update +
+controltower:UpdateEnabledBaseline,
+controltower:GetBaselineOperation,
+organizations:CreateOrganizationalUnit,
+organizations:CreateOrganization,
+organizations:UpdatePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:DeletePolicy,
+organizations:EnablePolicyType,
+organizations:EnableAWSServiceAccess,
+organizations:ListRoots,
+servicecatalog:AssociatePrincipalWithPortfolio,
+servicecatalog:AssociateProductWithPortfolio,
+servicecatalog:CreatePortfolio,
+servicecatalog:CreateProduct,
+servicecatalog:CreateProvisioningArtifact,
+servicecatalog:ListPortfolios,
+servicecatalog:ListProvisioningArtifacts,
+servicecatalog:SearchProductsAsAdmin,
+servicecatalog:UpdatePortfolio,
+servicecatalog:UpdateProvisioningArtifact,
+servicecatalog:ListPrincipalsForPortfolio,
+servicecatalog:DeleteProvisioningArtifact,
+controltower:TagResource,
+controltower:ListTagsForResource,
+controltower:GetEnabledBaseline
+ +### Delete +
+controltower:DisableBaseline,
+controltower:GetBaselineOperation,
+organizations:CreateOrganizationalUnit,
+organizations:CreateOrganization,
+organizations:UpdatePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:DeletePolicy,
+organizations:EnablePolicyType,
+organizations:EnableAWSServiceAccess,
+organizations:ListRoots,
+servicecatalog:AssociatePrincipalWithPortfolio,
+servicecatalog:AssociateProductWithPortfolio,
+servicecatalog:CreatePortfolio,
+servicecatalog:CreateProduct,
+servicecatalog:CreateProvisioningArtifact,
+servicecatalog:ListPortfolios,
+servicecatalog:ListProvisioningArtifacts,
+servicecatalog:SearchProductsAsAdmin,
+servicecatalog:UpdatePortfolio,
+servicecatalog:UpdateProvisioningArtifact,
+servicecatalog:ListPrincipalsForPortfolio,
+servicecatalog:DeleteProvisioningArtifact
+ + +## Example +```sql +SELECT +region, +baseline_identifier, +baseline_version, +enabled_baseline_identifier, +target_identifier, +parameters, +tags +FROM awscc.controltower.enabled_baseline +WHERE region = 'us-east-1' +AND data__Identifier = '<EnabledBaselineIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md b/docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md new file mode 100644 index 0000000000..77fb3f86a8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md @@ -0,0 +1,84 @@ +--- +title: enabled_baselines +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_baselines + - 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 +--- +Retrieves a list of enabled_baselines in a region + +## Overview + + + + + +
Nameenabled_baselines
TypeResource
Descriptionenabled_baselines
Idawscc.controltower.enabled_baselines
+ +## Fields + + + + + +
NameDatatypeDescription
enabled_baseline_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the enabled_baselines resource, the following permissions are required: + +### Create +
+controltower:EnableBaseline,
+controltower:TagResource,
+controltower:GetBaselineOperation,
+controltower:GetEnabledBaseline,
+controltower:ListTagsForResource,
+organizations:CreateOrganizationalUnit,
+organizations:CreateOrganization,
+organizations:UpdatePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:DeletePolicy,
+organizations:EnablePolicyType,
+organizations:EnableAWSServiceAccess,
+organizations:ListRoots,
+servicecatalog:AssociatePrincipalWithPortfolio,
+servicecatalog:AssociateProductWithPortfolio,
+servicecatalog:CreatePortfolio,
+servicecatalog:CreateProduct,
+servicecatalog:CreateProvisioningArtifact,
+servicecatalog:ListPortfolios,
+servicecatalog:ListProvisioningArtifacts,
+servicecatalog:SearchProductsAsAdmin,
+servicecatalog:UpdatePortfolio,
+servicecatalog:UpdateProvisioningArtifact,
+servicecatalog:ListPrincipalsForPortfolio,
+servicecatalog:DeleteProvisioningArtifact
+ +### List +
+controltower:ListEnabledBaselines
+ + +## Example +```sql +SELECT +region, +enabled_baseline_identifier +FROM awscc.controltower.enabled_baselines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md b/docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md new file mode 100644 index 0000000000..5258dd036d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md @@ -0,0 +1,93 @@ +--- +title: enabled_control +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_control + - 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 +--- +Gets an individual enabled_control resource + +## Overview + + + + + +
Nameenabled_control
TypeResource
Descriptionenabled_control
Idawscc.controltower.enabled_control
+ +## Fields + + + + + + + + +
NameDatatypeDescription
control_identifierstringArn of the control.
target_identifierstringArn for Organizational unit to which the control needs to be applied
parametersarrayParameters to configure the enabled control behavior.
tagsarrayA set of tags to assign to the enabled control.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the enabled_control resource, the following permissions are required: + +### Update +
+controltower:ListEnabledControls,
+controltower:GetEnabledControl,
+controltower:GetControlOperation,
+controltower:UpdateEnabledControl,
+controltower:UntagResource,
+controltower:TagResource,
+organizations:UpdatePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:ListPoliciesForTarget,
+organizations:ListTargetsForPolicy,
+organizations:DescribePolicy
+ +### Delete +
+controltower:GetControlOperation,
+controltower:DisableControl,
+organizations:UpdatePolicy,
+organizations:DeletePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:ListPoliciesForTarget,
+organizations:ListTargetsForPolicy,
+organizations:DescribePolicy
+ +### Read +
+controltower:ListEnabledControls,
+controltower:GetEnabledControl,
+controltower:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +control_identifier, +target_identifier, +parameters, +tags +FROM awscc.controltower.enabled_control +WHERE region = 'us-east-1' +AND data__Identifier = '<TargetIdentifier>' +AND data__Identifier = '<ControlIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md b/docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md new file mode 100644 index 0000000000..001a061e13 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md @@ -0,0 +1,71 @@ +--- +title: enabled_controls +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_controls + - 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 +--- +Retrieves a list of enabled_controls in a region + +## Overview + + + + + +
Nameenabled_controls
TypeResource
Descriptionenabled_controls
Idawscc.controltower.enabled_controls
+ +## Fields + + + + + + +
NameDatatypeDescription
target_identifierstringArn for Organizational unit to which the control needs to be applied
control_identifierstringArn of the control.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the enabled_controls resource, the following permissions are required: + +### Create +
+controltower:ListEnabledControls,
+controltower:GetEnabledControl,
+controltower:GetControlOperation,
+controltower:EnableControl,
+controltower:TagResource,
+organizations:UpdatePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:ListPoliciesForTarget,
+organizations:ListTargetsForPolicy,
+organizations:DescribePolicy
+ +### List +
+controltower:ListEnabledControls
+ + +## Example +```sql +SELECT +region, +target_identifier, +control_identifier +FROM awscc.controltower.enabled_controls +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/controltower/index.md b/docs/awscc-docs/providers/awscc/controltower/index.md new file mode 100644 index 0000000000..1aa857f948 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/controltower/index.md @@ -0,0 +1,43 @@ +--- +title: controltower +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The controltower service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+enabled_baseline
+enabled_baselines
+enabled_control +
+
+enabled_controls
+landing_zone
+landing_zones +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/controltower/landing_zone/index.md b/docs/awscc-docs/providers/awscc/controltower/landing_zone/index.md new file mode 100644 index 0000000000..3981b3b9c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/controltower/landing_zone/index.md @@ -0,0 +1,130 @@ +--- +title: landing_zone +hide_title: false +hide_table_of_contents: false +keywords: + - landing_zone + - 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 +--- +Gets an individual landing_zone resource + +## Overview + + + + + +
Namelanding_zone
TypeResource
Descriptionlanding_zone
Idawscc.controltower.landing_zone
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
landing_zone_identifierstring
arnstring
statusstring
latest_available_versionstring
drift_statusstring
manifestundefined
versionstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the landing_zone resource, the following permissions are required: + +### Read +
+controltower:GetLandingZone,
+controltower:ListTagsForResource
+ +### Update +
+controltower:UpdateLandingZone,
+controltower:GetLandingZoneOperation,
+controltower:ListTagsForResource,
+controltower:TagResource,
+controltower:GetLandingZone,
+controltower:UntagResource,
+cloudformation:DescribeOrganizationsAccess,
+servicecatalog:AssociatePrincipalWithPortfolio,
+servicecatalog:AssociateProductWithPortfolio,
+servicecatalog:CreatePortfolio,
+servicecatalog:CreateProduct,
+servicecatalog:CreateProvisioningArtifact,
+servicecatalog:ListPortfolios,
+servicecatalog:ListProvisioningArtifacts,
+servicecatalog:SearchProductsAsAdmin,
+servicecatalog:UpdatePortfolio,
+servicecatalog:UpdateProvisioningArtifact,
+servicecatalog:ListPrincipalsForPortfolio,
+organizations:CreateOrganizationalUnit,
+organizations:CreateOrganization,
+organizations:UpdatePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:DeletePolicy,
+organizations:EnablePolicyType,
+organizations:EnableAWSServiceAccess,
+organizations:ListRoots,
+sso:GetPeregrineStatus,
+sso:ListDirectoryAssociations,
+sso:StartPeregrine,
+sso:RegisterRegion
+ +### Delete +
+controltower:DeleteLandingZone,
+controltower:GetLandingZone,
+controltower:GetLandingZoneOperation,
+cloudformation:DescribeOrganizationsAccess,
+servicecatalog:ListPortfolios,
+servicecatalog:ListProvisioningArtifacts,
+servicecatalog:SearchProductsAsAdmin,
+servicecatalog:DeleteProvisioningArtifact,
+servicecatalog:ListPrincipalsForPortfolio,
+servicecatalog:DeleteProduct,
+servicecatalog:DisassociatePrincipalFromPortfolio,
+servicecatalog:DisassociateProductFromPortfolio,
+servicecatalog:DeletePortfolio,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:DeletePolicy,
+organizations:ListRoots,
+sso:GetPeregrineStatus,
+sso:ListDirectoryAssociations,
+iam:DeleteRolePolicy,
+iam:DetachRolePolicy,
+iam:DeleteRole
+ + +## Example +```sql +SELECT +region, +landing_zone_identifier, +arn, +status, +latest_available_version, +drift_status, +manifest, +version, +tags +FROM awscc.controltower.landing_zone +WHERE region = 'us-east-1' +AND data__Identifier = '<LandingZoneIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md b/docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md new file mode 100644 index 0000000000..e274d2714d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md @@ -0,0 +1,88 @@ +--- +title: landing_zones +hide_title: false +hide_table_of_contents: false +keywords: + - landing_zones + - 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 +--- +Retrieves a list of landing_zones in a region + +## Overview + + + + + +
Namelanding_zones
TypeResource
Descriptionlanding_zones
Idawscc.controltower.landing_zones
+ +## Fields + + + + + +
NameDatatypeDescription
landing_zone_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the landing_zones resource, the following permissions are required: + +### Create +
+controltower:CreateLandingZone,
+controltower:GetLandingZoneOperation,
+controltower:ListTagsForResource,
+controltower:TagResource,
+controltower:GetLandingZone,
+cloudformation:DescribeOrganizationsAccess,
+servicecatalog:AssociatePrincipalWithPortfolio,
+servicecatalog:AssociateProductWithPortfolio,
+servicecatalog:CreatePortfolio,
+servicecatalog:CreateProduct,
+servicecatalog:CreateProvisioningArtifact,
+servicecatalog:ListPortfolios,
+servicecatalog:ListProvisioningArtifacts,
+servicecatalog:SearchProductsAsAdmin,
+servicecatalog:UpdatePortfolio,
+servicecatalog:UpdateProvisioningArtifact,
+servicecatalog:ListPrincipalsForPortfolio,
+organizations:CreateOrganizationalUnit,
+organizations:CreateOrganization,
+organizations:UpdatePolicy,
+organizations:CreatePolicy,
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:DeletePolicy,
+organizations:EnablePolicyType,
+organizations:EnableAWSServiceAccess,
+organizations:ListRoots,
+sso:GetPeregrineStatus,
+sso:ListDirectoryAssociations,
+sso:StartPeregrine,
+sso:RegisterRegion
+ +### List +
+controltower:ListLandingZones
+ + +## Example +```sql +SELECT +region, +landing_zone_identifier +FROM awscc.controltower.landing_zones +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/cur/index.md b/docs/awscc-docs/providers/awscc/cur/index.md new file mode 100644 index 0000000000..628fc63e17 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cur/index.md @@ -0,0 +1,39 @@ +--- +title: cur +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The cur service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+report_definition +
+
+report_definitions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cur/report_definition/index.md b/docs/awscc-docs/providers/awscc/cur/report_definition/index.md new file mode 100644 index 0000000000..a575a15d8f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cur/report_definition/index.md @@ -0,0 +1,87 @@ +--- +title: report_definition +hide_title: false +hide_table_of_contents: false +keywords: + - report_definition + - 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 +--- +Gets an individual report_definition resource + +## Overview + + + + + +
Namereport_definition
TypeResource
Descriptionreport_definition
Idawscc.cur.report_definition
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
report_namestringThe name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
time_unitstringThe granularity of the line items in the report.
formatstringThe format that AWS saves the report in.
compressionstringThe compression format that AWS uses for the report.
additional_schema_elementsarrayA list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
s3_bucketstringThe S3 bucket where AWS delivers the report.
s3_prefixstringThe prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.
s3_regionstringThe region of the S3 bucket that AWS delivers the report into.
additional_artifactsarrayA list of manifests that you want Amazon Web Services to create for this report.
refresh_closed_reportsbooleanWhether 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.
report_versioningstringWhether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
billing_view_arnstringThe Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the report_definition resource, the following permissions are required: + +### Read +
+cur:DescribeReportDefinitions
+ +### Update +
+cur:DescribeReportDefinitions,
+cur:ModifyReportDefinition
+ +### Delete +
+cur:DescribeReportDefinitions,
+cur:DeleteReportDefinition
+ + +## Example +```sql +SELECT +region, +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 awscc.cur.report_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<ReportName>' +``` diff --git a/docs/awscc-docs/providers/awscc/cur/report_definitions/index.md b/docs/awscc-docs/providers/awscc/cur/report_definitions/index.md new file mode 100644 index 0000000000..3ff8f6bfe4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/cur/report_definitions/index.md @@ -0,0 +1,58 @@ +--- +title: report_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - report_definitions + - 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 +--- +Retrieves a list of report_definitions in a region + +## Overview + + + + + +
Namereport_definitions
TypeResource
Descriptionreport_definitions
Idawscc.cur.report_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
report_namestringThe name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the report_definitions resource, the following permissions are required: + +### Create +
+cur:PutReportDefinition
+ +### List +
+cur:DescribeReportDefinitions
+ + +## Example +```sql +SELECT +region, +report_name +FROM awscc.cur.report_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definition/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definition/index.md new file mode 100644 index 0000000000..de8caccc4a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definition/index.md @@ -0,0 +1,85 @@ +--- +title: calculated_attribute_definition +hide_title: false +hide_table_of_contents: false +keywords: + - calculated_attribute_definition + - 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 +--- +Gets an individual calculated_attribute_definition resource + +## Overview + + + + + +
Namecalculated_attribute_definition
TypeResource
Descriptioncalculated_attribute_definition
Idawscc.customerprofiles.calculated_attribute_definition
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestring
calculated_attribute_namestring
display_namestring
descriptionstring
attribute_detailsobject
conditionsobject
statisticstring
created_atstringThe timestamp of when the calculated attribute definition was created.
last_updated_atstringThe timestamp of when the calculated attribute definition was most recently edited.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the calculated_attribute_definition resource, the following permissions are required: + +### Read +
+profile:GetCalculatedAttributeDefinition
+ +### Update +
+profile:GetCalculatedAttributeDefinition,
+profile:UpdateCalculatedAttributeDefinition,
+profile:UntagResource,
+profile:TagResource
+ +### Delete +
+profile:DeleteCalculatedAttributeDefinition
+ + +## Example +```sql +SELECT +region, +domain_name, +calculated_attribute_name, +display_name, +description, +attribute_details, +conditions, +statistic, +created_at, +last_updated_at, +tags +FROM awscc.customerprofiles.calculated_attribute_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +AND data__Identifier = '<CalculatedAttributeName>' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definitions/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definitions/index.md new file mode 100644 index 0000000000..353b5f95d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definitions/index.md @@ -0,0 +1,61 @@ +--- +title: calculated_attribute_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - calculated_attribute_definitions + - 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 +--- +Retrieves a list of calculated_attribute_definitions in a region + +## Overview + + + + + +
Namecalculated_attribute_definitions
TypeResource
Descriptioncalculated_attribute_definitions
Idawscc.customerprofiles.calculated_attribute_definitions
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_nameundefined
calculated_attribute_nameundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the calculated_attribute_definitions resource, the following permissions are required: + +### Create +
+profile:CreateCalculatedAttributeDefinition,
+profile:TagResource
+ +### List +
+profile:ListCalculatedAttributeDefinitions
+ + +## Example +```sql +SELECT +region, +domain_name, +calculated_attribute_name +FROM awscc.customerprofiles.calculated_attribute_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md new file mode 100644 index 0000000000..44c65349fd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md @@ -0,0 +1,84 @@ +--- +title: domain +hide_title: false +hide_table_of_contents: false +keywords: + - domain + - 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 +--- +Gets an individual domain resource + +## Overview + + + + + +
Namedomain
TypeResource
Descriptiondomain
Idawscc.customerprofiles.domain
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
dead_letter_queue_urlstringThe URL of the SQS dead letter queue
default_encryption_keystringThe default encryption key
default_expiration_daysintegerThe default number of days until the data within the domain expires.
matchingobject
rule_based_matchingobject
statsobject
tagsarrayThe tags (keys and values) associated with the domain
created_atstringThe time of this integration got created
last_updated_atstringThe time of this integration got last updated at
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +
+profile:GetDomain
+ +### Update +
+profile:GetDomain,
+profile:UpdateDomain,
+profile:UntagResource,
+profile:TagResource
+ +### Delete +
+profile:DeleteDomain
+ + +## Example +```sql +SELECT +region, +domain_name, +dead_letter_queue_url, +default_encryption_key, +default_expiration_days, +matching, +rule_based_matching, +stats, +tags, +created_at, +last_updated_at +FROM awscc.customerprofiles.domain +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md new file mode 100644 index 0000000000..edf4ef82bf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md @@ -0,0 +1,59 @@ +--- +title: domains +hide_title: false +hide_table_of_contents: false +keywords: + - domains + - 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 +--- +Retrieves a list of domains in a region + +## Overview + + + + + +
Namedomains
TypeResource
Descriptiondomains
Idawscc.customerprofiles.domains
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +
+profile:CreateDomain,
+profile:TagResource
+ +### List +
+profile:ListDomains
+ + +## Example +```sql +SELECT +region, +domain_name +FROM awscc.customerprofiles.domains +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md new file mode 100644 index 0000000000..b78f1035f9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md @@ -0,0 +1,83 @@ +--- +title: event_stream +hide_title: false +hide_table_of_contents: false +keywords: + - event_stream + - 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 +--- +Gets an individual event_stream resource + +## Overview + + + + + +
Nameevent_stream
TypeResource
Descriptionevent_stream
Idawscc.customerprofiles.event_stream
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
event_stream_namestringThe name of the event stream.
uristring
event_stream_arnstringA unique identifier for the event stream.
tagsarrayThe tags used to organize, track, or control access for this resource.
created_atstringThe timestamp of when the export was created.
statestringThe operational state of destination stream for export.
destination_detailsobjectDetails regarding the Kinesis stream.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_stream resource, the following permissions are required: + +### Read +
+profile:GetEventStream,
+kinesis:DescribeStreamSummary
+ +### Update +
+kinesis:DescribeStreamSummary,
+profile:GetEventStream,
+profile:UntagResource,
+profile:TagResource
+ +### Delete +
+profile:DeleteEventStream,
+iam:DeleteRolePolicy
+ + +## Example +```sql +SELECT +region, +domain_name, +event_stream_name, +uri, +event_stream_arn, +tags, +created_at, +state, +destination_details +FROM awscc.customerprofiles.event_stream +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +AND data__Identifier = '<EventStreamName>' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md new file mode 100644 index 0000000000..d617af4409 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md @@ -0,0 +1,63 @@ +--- +title: event_streams +hide_title: false +hide_table_of_contents: false +keywords: + - event_streams + - 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 +--- +Retrieves a list of event_streams in a region + +## Overview + + + + + +
Nameevent_streams
TypeResource
Descriptionevent_streams
Idawscc.customerprofiles.event_streams
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
event_stream_namestringThe name of the event stream.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_streams resource, the following permissions are required: + +### Create +
+profile:CreateEventStream,
+iam:PutRolePolicy,
+kinesis:DescribeStreamSummary,
+profile:TagResource
+ +### List +
+profile:ListEventStreams
+ + +## Example +```sql +SELECT +region, +domain_name, +event_stream_name +FROM awscc.customerprofiles.event_streams +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/index.md new file mode 100644 index 0000000000..93e12e402e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/index.md @@ -0,0 +1,47 @@ +--- +title: customerprofiles +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The customerprofiles service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+calculated_attribute_definition
+calculated_attribute_definitions
+domain
+domains
+event_stream +
+
+event_streams
+integration
+integrations
+object_type
+object_types +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/integration/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/integration/index.md new file mode 100644 index 0000000000..83a9d057b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/integration/index.md @@ -0,0 +1,98 @@ +--- +title: integration +hide_title: false +hide_table_of_contents: false +keywords: + - integration + - 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 +--- +Gets an individual integration resource + +## Overview + + + + + +
Nameintegration
TypeResource
Descriptionintegration
Idawscc.customerprofiles.integration
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
uristringThe URI of the S3 bucket or any other type of data source.
flow_definitionobject
object_type_namestringThe name of the ObjectType defined for the 3rd party data in Profile Service
created_atstringThe time of this integration got created
last_updated_atstringThe time of this integration got last updated at
tagsarrayThe tags (keys and values) associated with the integration
object_type_namesarrayThe mapping between 3rd party event types and ObjectType names
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integration resource, the following permissions are required: + +### Read +
+profile:GetIntegration
+ +### Delete +
+profile:DeleteIntegration,
+appflow:DeleteFlow,
+app-integrations:ListEventIntegrationAssociations,
+app-integrations:DeleteEventIntegrationAssociation,
+events:RemoveTargets,
+events:ListTargetsByRule,
+events:DeleteRule
+ +### Update +
+profile:PutIntegration,
+profile:GetIntegration,
+appflow:CreateFlow,
+app-integrations:GetEventIntegration,
+app-integrations:CreateEventIntegrationAssociation,
+app-integrations:ListEventIntegrationAssociations,
+app-integrations:DeleteEventIntegrationAssociation,
+events:ListTargetsByRule,
+events:RemoveTargets,
+events:DeleteRule,
+events:PutRule,
+events:PutTargets,
+events:PutEvents,
+profile:UntagResource,
+profile:TagResource
+ + +## Example +```sql +SELECT +region, +domain_name, +uri, +flow_definition, +object_type_name, +created_at, +last_updated_at, +tags, +object_type_names +FROM awscc.customerprofiles.integration +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +AND data__Identifier = '<Uri>' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md new file mode 100644 index 0000000000..7c3fb2301c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md @@ -0,0 +1,69 @@ +--- +title: integrations +hide_title: false +hide_table_of_contents: false +keywords: + - integrations + - 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 +--- +Retrieves a list of integrations in a region + +## Overview + + + + + +
Nameintegrations
TypeResource
Descriptionintegrations
Idawscc.customerprofiles.integrations
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
uristringThe URI of the S3 bucket or any other type of data source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integrations resource, the following permissions are required: + +### Create +
+profile:GetIntegration,
+profile:PutIntegration,
+appflow:CreateFlow,
+app-integrations:CreateEventIntegrationAssociation,
+app-integrations:GetEventIntegration,
+events:ListTargetsByRule,
+events:PutRule,
+events:PutTargets,
+events:PutEvents,
+profile:TagResource
+ +### List +
+profile:ListIntegrations
+ + +## Example +```sql +SELECT +region, +domain_name, +uri +FROM awscc.customerprofiles.integrations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md new file mode 100644 index 0000000000..7c70a080ca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md @@ -0,0 +1,91 @@ +--- +title: object_type +hide_title: false +hide_table_of_contents: false +keywords: + - object_type + - 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 +--- +Gets an individual object_type resource + +## Overview + + + + + +
Nameobject_type
TypeResource
Descriptionobject_type
Idawscc.customerprofiles.object_type
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
object_type_namestringThe name of the profile object type.
allow_profile_creationbooleanIndicates whether a profile should be created when data is received.
descriptionstringDescription of the profile object type.
encryption_keystringThe default encryption key
expiration_daysintegerThe default number of days until the data within the domain expires.
fieldsarrayA list of the name and ObjectType field.
keysarrayA list of unique keys that can be used to map data to the profile.
created_atstringThe time of this integration got created.
last_updated_atstringThe time of this integration got last updated at.
source_last_updated_timestamp_formatstringThe format of your sourceLastUpdatedTimestamp that was previously set up.
tagsarrayThe tags (keys and values) associated with the integration.
template_idstringA unique identifier for the object template.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the object_type resource, the following permissions are required: + +### Read +
+profile:GetProfileObjectType
+ +### Update +
+profile:GetProfileObjectType,
+profile:PutProfileObjectType,
+profile:UntagResource,
+profile:TagResource
+ +### Delete +
+profile:DeleteProfileObjectType
+ + +## Example +```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, +tags, +template_id +FROM awscc.customerprofiles.object_type +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +AND data__Identifier = '<ObjectTypeName>' +``` diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md new file mode 100644 index 0000000000..1c11e66c58 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md @@ -0,0 +1,62 @@ +--- +title: object_types +hide_title: false +hide_table_of_contents: false +keywords: + - object_types + - 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 +--- +Retrieves a list of object_types in a region + +## Overview + + + + + +
Nameobject_types
TypeResource
Descriptionobject_types
Idawscc.customerprofiles.object_types
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
object_type_namestringThe name of the profile object type.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the object_types resource, the following permissions are required: + +### Create +
+profile:GetProfileObjectType,
+profile:PutProfileObjectType,
+profile:TagResource
+ +### List +
+profile:ListProfileObjectTypes
+ + +## Example +```sql +SELECT +region, +domain_name, +object_type_name +FROM awscc.customerprofiles.object_types +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/dataset/index.md b/docs/awscc-docs/providers/awscc/databrew/dataset/index.md new file mode 100644 index 0000000000..70e497d612 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/dataset/index.md @@ -0,0 +1,77 @@ +--- +title: dataset +hide_title: false +hide_table_of_contents: false +keywords: + - dataset + - 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 +--- +Gets an individual dataset resource + +## Overview + + + + + +
Namedataset
TypeResource
Descriptiondataset
Idawscc.databrew.dataset
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringDataset name
formatstringDataset format
format_optionsobjectFormat options for dataset
inputobjectInput
path_optionsobjectPathOptions
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +
+databrew:DescribeDataset,
+databrew:ListTagsForResource,
+iam:ListRoles
+ +### Update +
+databrew:UpdateDataset,
+glue:GetConnection,
+glue:GetTable
+ +### Delete +
+databrew:DeleteDataset
+ + +## Example +```sql +SELECT +region, +name, +format, +format_options, +input, +path_options, +tags +FROM awscc.databrew.dataset +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/datasets/index.md b/docs/awscc-docs/providers/awscc/databrew/datasets/index.md new file mode 100644 index 0000000000..25fc32e738 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/datasets/index.md @@ -0,0 +1,65 @@ +--- +title: datasets +hide_title: false +hide_table_of_contents: false +keywords: + - datasets + - 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 +--- +Retrieves a list of datasets in a region + +## Overview + + + + + +
Namedatasets
TypeResource
Descriptiondatasets
Idawscc.databrew.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringDataset name
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +
+databrew:CreateDataset,
+databrew:TagResource,
+databrew:UntagResource,
+glue:GetConnection,
+glue:GetTable,
+iam:PassRole
+ +### List +
+databrew:ListDatasets,
+databrew:ListTagsForResource,
+iam:ListRoles
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.databrew.datasets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/index.md b/docs/awscc-docs/providers/awscc/databrew/index.md new file mode 100644 index 0000000000..7266f8fe88 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/index.md @@ -0,0 +1,49 @@ +--- +title: databrew +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The databrew service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+dataset
+datasets
+job
+jobs
+project
+projects +
+
+recipe
+recipes
+ruleset
+rulesets
+schedule
+schedules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/databrew/job/index.md b/docs/awscc-docs/providers/awscc/databrew/job/index.md new file mode 100644 index 0000000000..9d688b7c65 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/job/index.md @@ -0,0 +1,105 @@ +--- +title: job +hide_title: false +hide_table_of_contents: false +keywords: + - job + - 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 +--- +Gets an individual job resource + +## Overview + + + + + +
Namejob
TypeResource
Descriptionjob
Idawscc.databrew.job
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
dataset_namestringDataset name
encryption_key_arnstringEncryption Key Arn
encryption_modestringEncryption mode
namestringJob name
typestringJob type
log_subscriptionstringLog subscription
max_capacityintegerMax capacity
max_retriesintegerMax retries
outputsarray
data_catalog_outputsarray
database_outputsarray
output_locationobjectOutput location
project_namestringProject name
recipeobject
role_arnstringRole arn
tagsarray
timeoutintegerTimeout
job_sampleobjectJob Sample
profile_configurationobjectProfile Job configuration
validation_configurationsarrayData quality rules configuration
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the job resource, the following permissions are required: + +### Read +
+databrew:DescribeJob,
+databrew:ListTagsForResource,
+iam:ListRoles
+ +### Update +
+databrew:UpdateProfileJob,
+databrew:UpdateRecipeJob,
+iam:PassRole
+ +### Delete +
+databrew:DeleteJob
+ + +## Example +```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, +tags, +timeout, +job_sample, +profile_configuration, +validation_configurations +FROM awscc.databrew.job +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/jobs/index.md b/docs/awscc-docs/providers/awscc/databrew/jobs/index.md new file mode 100644 index 0000000000..d78087d6f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/jobs/index.md @@ -0,0 +1,64 @@ +--- +title: jobs +hide_title: false +hide_table_of_contents: false +keywords: + - jobs + - 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 +--- +Retrieves a list of jobs in a region + +## Overview + + + + + +
Namejobs
TypeResource
Descriptionjobs
Idawscc.databrew.jobs
+ +## Fields + + + + + +
NameDatatypeDescription
namestringJob name
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the jobs resource, the following permissions are required: + +### Create +
+databrew:CreateProfileJob,
+databrew:CreateRecipeJob,
+databrew:TagResource,
+databrew:UntagResource,
+iam:PassRole
+ +### List +
+databrew:ListJobs,
+databrew:ListTagsForResource,
+iam:ListRoles
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.databrew.jobs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/project/index.md b/docs/awscc-docs/providers/awscc/databrew/project/index.md new file mode 100644 index 0000000000..5c003f8a1d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/project/index.md @@ -0,0 +1,76 @@ +--- +title: project +hide_title: false +hide_table_of_contents: false +keywords: + - project + - 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 +--- +Gets an individual project resource + +## Overview + + + + + +
Nameproject
TypeResource
Descriptionproject
Idawscc.databrew.project
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
dataset_namestringDataset name
namestringProject name
recipe_namestringRecipe name
role_arnstringRole arn
sampleobjectSample
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +
+databrew:DescribeProject,
+databrew:ListTagsForResource,
+iam:ListRoles
+ +### Update +
+databrew:UpdateProject,
+iam:PassRole
+ +### Delete +
+databrew:DeleteProject
+ + +## Example +```sql +SELECT +region, +dataset_name, +name, +recipe_name, +role_arn, +sample, +tags +FROM awscc.databrew.project +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/projects/index.md b/docs/awscc-docs/providers/awscc/databrew/projects/index.md new file mode 100644 index 0000000000..9d9fed6d9c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/projects/index.md @@ -0,0 +1,63 @@ +--- +title: projects +hide_title: false +hide_table_of_contents: false +keywords: + - projects + - 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 +--- +Retrieves a list of projects in a region + +## Overview + + + + + +
Nameprojects
TypeResource
Descriptionprojects
Idawscc.databrew.projects
+ +## Fields + + + + + +
NameDatatypeDescription
namestringProject name
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +
+databrew:CreateProject,
+databrew:TagResource,
+databrew:UntagResource,
+iam:PassRole
+ +### List +
+databrew:ListProjects,
+databrew:ListTagsForResource,
+iam:ListRoles
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.databrew.projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/recipe/index.md b/docs/awscc-docs/providers/awscc/databrew/recipe/index.md new file mode 100644 index 0000000000..3379f544b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/recipe/index.md @@ -0,0 +1,71 @@ +--- +title: recipe +hide_title: false +hide_table_of_contents: false +keywords: + - recipe + - 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 +--- +Gets an individual recipe resource + +## Overview + + + + + +
Namerecipe
TypeResource
Descriptionrecipe
Idawscc.databrew.recipe
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringDescription of the recipe
namestringRecipe name
stepsarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the recipe resource, the following permissions are required: + +### Read +
+databrew:DescribeRecipe,
+databrew:ListTagsForResource,
+iam:ListRoles
+ +### Delete +
+databrew:DeleteRecipeVersion
+ +### Update +
+databrew:UpdateRecipe
+ + +## Example +```sql +SELECT +region, +description, +name, +steps, +tags +FROM awscc.databrew.recipe +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/recipes/index.md b/docs/awscc-docs/providers/awscc/databrew/recipes/index.md new file mode 100644 index 0000000000..98e6db2caf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/recipes/index.md @@ -0,0 +1,63 @@ +--- +title: recipes +hide_title: false +hide_table_of_contents: false +keywords: + - recipes + - 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 +--- +Retrieves a list of recipes in a region + +## Overview + + + + + +
Namerecipes
TypeResource
Descriptionrecipes
Idawscc.databrew.recipes
+ +## Fields + + + + + +
NameDatatypeDescription
namestringRecipe name
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the recipes resource, the following permissions are required: + +### Create +
+databrew:CreateRecipe,
+databrew:TagResource,
+databrew:UntagResource,
+iam:PassRole
+ +### List +
+databrew:ListRecipes,
+databrew:ListTagsForResource,
+iam:ListRoles
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.databrew.recipes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/ruleset/index.md b/docs/awscc-docs/providers/awscc/databrew/ruleset/index.md new file mode 100644 index 0000000000..34d251fca6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/ruleset/index.md @@ -0,0 +1,73 @@ +--- +title: ruleset +hide_title: false +hide_table_of_contents: false +keywords: + - ruleset + - 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 +--- +Gets an individual ruleset resource + +## Overview + + + + + +
Nameruleset
TypeResource
Descriptionruleset
Idawscc.databrew.ruleset
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringName of the Ruleset
descriptionstringDescription of the Ruleset
target_arnstringArn of the target resource (dataset) to apply the ruleset to
rulesarrayList of the data quality rules in the ruleset
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ruleset resource, the following permissions are required: + +### Read +
+databrew:DescribeRuleset,
+databrew:ListTagsForResource,
+iam:ListRoles
+ +### Update +
+databrew:UpdateRuleset
+ +### Delete +
+databrew:DeleteRuleset
+ + +## Example +```sql +SELECT +region, +name, +description, +target_arn, +rules, +tags +FROM awscc.databrew.ruleset +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/rulesets/index.md b/docs/awscc-docs/providers/awscc/databrew/rulesets/index.md new file mode 100644 index 0000000000..ba6f0d2d31 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/rulesets/index.md @@ -0,0 +1,63 @@ +--- +title: rulesets +hide_title: false +hide_table_of_contents: false +keywords: + - rulesets + - 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 +--- +Retrieves a list of rulesets in a region + +## Overview + + + + + +
Namerulesets
TypeResource
Descriptionrulesets
Idawscc.databrew.rulesets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the Ruleset
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rulesets resource, the following permissions are required: + +### Create +
+databrew:CreateRuleset,
+databrew:TagResource,
+databrew:UntagResource,
+iam:PassRole
+ +### List +
+databrew:ListRulesets,
+databrew:ListTagsForResource,
+iam:ListRoles
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.databrew.rulesets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/schedule/index.md b/docs/awscc-docs/providers/awscc/databrew/schedule/index.md new file mode 100644 index 0000000000..4afce6951e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/schedule/index.md @@ -0,0 +1,71 @@ +--- +title: schedule +hide_title: false +hide_table_of_contents: false +keywords: + - schedule + - 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 +--- +Gets an individual schedule resource + +## Overview + + + + + +
Nameschedule
TypeResource
Descriptionschedule
Idawscc.databrew.schedule
+ +## Fields + + + + + + + + +
NameDatatypeDescription
job_namesarray
cron_expressionstringSchedule cron
namestringSchedule Name
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schedule resource, the following permissions are required: + +### Read +
+databrew:DescribeSchedule,
+databrew:ListTagsForResource,
+iam:ListRoles
+ +### Update +
+databrew:UpdateSchedule
+ +### Delete +
+databrew:DeleteSchedule
+ + +## Example +```sql +SELECT +region, +job_names, +cron_expression, +name, +tags +FROM awscc.databrew.schedule +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/databrew/schedules/index.md b/docs/awscc-docs/providers/awscc/databrew/schedules/index.md new file mode 100644 index 0000000000..db31b961f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/databrew/schedules/index.md @@ -0,0 +1,63 @@ +--- +title: schedules +hide_title: false +hide_table_of_contents: false +keywords: + - schedules + - 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 +--- +Retrieves a list of schedules in a region + +## Overview + + + + + +
Nameschedules
TypeResource
Descriptionschedules
Idawscc.databrew.schedules
+ +## Fields + + + + + +
NameDatatypeDescription
namestringSchedule Name
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schedules resource, the following permissions are required: + +### Create +
+databrew:CreateSchedule,
+databrew:TagResource,
+databrew:UntagResource,
+iam:PassRole
+ +### List +
+databrew:ListSchedules,
+databrew:ListTagsForResource,
+iam:ListRoles
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.databrew.schedules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datapipeline/index.md b/docs/awscc-docs/providers/awscc/datapipeline/index.md new file mode 100644 index 0000000000..e179bb4ca5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datapipeline/index.md @@ -0,0 +1,39 @@ +--- +title: datapipeline +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The datapipeline service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+pipeline +
+
+pipelines +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/datapipeline/pipeline/index.md b/docs/awscc-docs/providers/awscc/datapipeline/pipeline/index.md new file mode 100644 index 0000000000..c028a6adf6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datapipeline/pipeline/index.md @@ -0,0 +1,91 @@ +--- +title: pipeline +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline + - 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 +--- +Gets an individual pipeline resource + +## Overview + + + + + +
Namepipeline
TypeResource
Descriptionpipeline
Idawscc.datapipeline.pipeline
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
activatebooleanIndicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
descriptionstringA description of the pipeline.
namestringThe name of the pipeline.
parameter_objectsarrayThe parameter objects used with the pipeline.
parameter_valuesarrayThe parameter values used with the pipeline.
pipeline_objectsarrayThe 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.
pipeline_tagsarrayA 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.
pipeline_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +
+datapipeline:GetPipelineDefinition,
+datapipeline:DescribePipelines
+ +### Update +
+datapipeline:PutPipelineDefinition,
+datapipeline:AddTags,
+datapipeline:RemoveTags,
+datapipeline:DeactivatePipeline,
+datapipeline:GetPipelineDefinition,
+datapipeline:ActivatePipeline,
+datapipeline:ValidatePipelineDefinition,
+datapipeline:DescribePipelines,
+datapipeline:AddTags,
+datapipeline:RemoveTags,
+iam:PassRole
+ +### Delete +
+datapipeline:DeletePipeline,
+datapipeline:DescribePipelines,
+datapipeline:GetPipelineDefinition,
+datapipeline:RemoveTags
+ + +## Example +```sql +SELECT +region, +activate, +description, +name, +parameter_objects, +parameter_values, +pipeline_objects, +pipeline_tags, +pipeline_id +FROM awscc.datapipeline.pipeline +WHERE region = 'us-east-1' +AND data__Identifier = '<PipelineId>' +``` diff --git a/docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md b/docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md new file mode 100644 index 0000000000..8aba22831d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md @@ -0,0 +1,65 @@ +--- +title: pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines + - 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 +--- +Retrieves a list of pipelines in a region + +## Overview + + + + + +
Namepipelines
TypeResource
Descriptionpipelines
Idawscc.datapipeline.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +
+datapipeline:CreatePipeline,
+datapipeline:PutPipelineDefinition,
+datapipeline:GetPipelineDefinition,
+datapipeline:DescribePipelines,
+datapipeline:ValidatePipelineDefinition,
+datapipeline:ActivatePipeline,
+datapipeline:AddTags,
+iam:PassRole
+ +### List +
+datapipeline:ListPipelines
+ + +## Example +```sql +SELECT +region, +pipeline_id +FROM awscc.datapipeline.pipelines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/agent/index.md b/docs/awscc-docs/providers/awscc/datasync/agent/index.md new file mode 100644 index 0000000000..82de97a192 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/agent/index.md @@ -0,0 +1,82 @@ +--- +title: agent +hide_title: false +hide_table_of_contents: false +keywords: + - agent + - 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 +--- +Gets an individual agent resource + +## Overview + + + + + +
Nameagent
TypeResource
Descriptionagent
Idawscc.datasync.agent
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
agent_namestringThe name configured for the agent. Text reference used to identify the agent in the console.
activation_keystringActivation key of the Agent.
security_group_arnsarrayThe ARNs of the security group used to protect your data transfer task subnets.
subnet_arnsarrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
vpc_endpoint_idstringThe ID of the VPC endpoint that the agent has access to.
endpoint_typestringThe service endpoints that the agent will connect to.
tagsarrayAn array of key-value pairs to apply to this resource.
agent_arnstringThe DataSync Agent ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the agent resource, the following permissions are required: + +### Read +
+datasync:DescribeAgent,
+datasync:ListTagsForResource
+ +### Update +
+datasync:UpdateAgent,
+datasync:DescribeAgent,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteAgent
+ + +## Example +```sql +SELECT +region, +agent_name, +activation_key, +security_group_arns, +subnet_arns, +vpc_endpoint_id, +endpoint_type, +tags, +agent_arn +FROM awscc.datasync.agent +WHERE region = 'us-east-1' +AND data__Identifier = '<AgentArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/agents/index.md b/docs/awscc-docs/providers/awscc/datasync/agents/index.md new file mode 100644 index 0000000000..b7259da320 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/agents/index.md @@ -0,0 +1,65 @@ +--- +title: agents +hide_title: false +hide_table_of_contents: false +keywords: + - agents + - 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 +--- +Retrieves a list of agents in a region + +## Overview + + + + + +
Nameagents
TypeResource
Descriptionagents
Idawscc.datasync.agents
+ +## Fields + + + + + +
NameDatatypeDescription
agent_arnstringThe DataSync Agent ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the agents resource, the following permissions are required: + +### Create +
+datasync:CreateAgent,
+datasync:TagResource,
+datasync:DescribeAgent,
+datasync:ListTagsForResource,
+ec2:DescribeNetworkInterfaces,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcEndpoints
+ +### List +
+datasync:ListAgents
+ + +## Example +```sql +SELECT +region, +agent_arn +FROM awscc.datasync.agents +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/index.md b/docs/awscc-docs/providers/awscc/datasync/index.md new file mode 100644 index 0000000000..ac9eb432e1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/index.md @@ -0,0 +1,60 @@ +--- +title: datasync +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The datasync service documentation. + +:::info Service Summary + +
+
+total resources: 23
+total selectable resources: 23
+total methods: 23
+
+
+ +::: + +## Resources +
+
+agent
+agents
+location_azure_blob
+location_azure_blobs
+location_efs
+location_hdfs
+location_nfs
+location_object_storage
+location_object_storages
+location_s3
+location_s3s
+location_smb +
+
+location_smbs
+locationf_sx_lustre
+locationf_sx_lustres
+locationf_sx_ontap
+locationf_sx_ontaps
+locationf_sx_open_zfs
+locationf_sx_windows
+storage_system
+storage_systems
+task
+tasks +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/datasync/location_azure_blob/index.md b/docs/awscc-docs/providers/awscc/datasync/location_azure_blob/index.md new file mode 100644 index 0000000000..c33ec1a2e2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_azure_blob/index.md @@ -0,0 +1,86 @@ +--- +title: location_azure_blob +hide_title: false +hide_table_of_contents: false +keywords: + - location_azure_blob + - 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 +--- +Gets an individual location_azure_blob resource + +## Overview + + + + + +
Namelocation_azure_blob
TypeResource
Descriptionlocation_azure_blob
Idawscc.datasync.location_azure_blob
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
agent_arnsarrayThe Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.
azure_blob_authentication_typestringThe specific authentication type that you want DataSync to use to access your Azure Blob Container.
azure_blob_sas_configurationobject
azure_blob_container_urlstringThe URL of the Azure Blob container that was described.
azure_blob_typestringSpecifies a blob type for the objects you're transferring into your Azure Blob Storage container.
azure_access_tierstringSpecifies an access tier for the objects you're transferring into your Azure Blob Storage container.
subdirectorystringThe subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
location_uristringThe URL of the Azure Blob Location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_azure_blob resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationAzureBlob,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationAzureBlob,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource,
+datasync:UpdateLocationAzureBlob
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +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 awscc.datasync.location_azure_blob +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_azure_blobs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_azure_blobs/index.md new file mode 100644 index 0000000000..a8f0f708a8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_azure_blobs/index.md @@ -0,0 +1,61 @@ +--- +title: location_azure_blobs +hide_title: false +hide_table_of_contents: false +keywords: + - location_azure_blobs + - 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 +--- +Retrieves a list of location_azure_blobs in a region + +## Overview + + + + + +
Namelocation_azure_blobs
TypeResource
Descriptionlocation_azure_blobs
Idawscc.datasync.location_azure_blobs
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_azure_blobs resource, the following permissions are required: + +### Create +
+datasync:CreateLocationAzureBlob,
+datasync:DescribeLocationAzureBlob,
+datasync:TagResource,
+datasync:ListTagsForResource
+ +### List +
+datasync:ListLocations
+ + +## Example +```sql +SELECT +region, +location_arn +FROM awscc.datasync.location_azure_blobs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_efs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_efs/index.md new file mode 100644 index 0000000000..bae91b3b39 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_efs/index.md @@ -0,0 +1,83 @@ +--- +title: location_efs +hide_title: false +hide_table_of_contents: false +keywords: + - location_efs + - 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 +--- +Gets an individual location_efs resource + +## Overview + + + + + +
Namelocation_efs
TypeResource
Descriptionlocation_efs
Idawscc.datasync.location_efs
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
ec2_configobject
efs_filesystem_arnstringThe Amazon Resource Name (ARN) for the Amazon EFS file system.
access_point_arnstringThe Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
file_system_access_role_arnstringThe Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
in_transit_encryptionstringProtocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
subdirectorystringA 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.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
location_uristringThe URL of the EFS location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_efs resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationEfs,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationEfs,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +ec2_config, +efs_filesystem_arn, +access_point_arn, +file_system_access_role_arn, +in_transit_encryption, +subdirectory, +tags, +location_arn, +location_uri +FROM awscc.datasync.location_efs +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md new file mode 100644 index 0000000000..937d3a7cf3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md @@ -0,0 +1,96 @@ +--- +title: location_hdfs +hide_title: false +hide_table_of_contents: false +keywords: + - location_hdfs + - 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 +--- +Gets an individual location_hdfs resource + +## Overview + + + + + +
Namelocation_hdfs
TypeResource
Descriptionlocation_hdfs
Idawscc.datasync.location_hdfs
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
name_nodesarrayAn array of Name Node(s) of the HDFS location.
block_sizeintegerSize of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
replication_factorintegerNumber of copies of each block that exists inside the HDFS cluster.
kms_key_provider_uristringThe identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
qop_configurationobject
authentication_typestringThe authentication mode used to determine identity of user.
simple_userstringThe user name that has read and write permissions on the specified HDFS cluster.
kerberos_principalstringThe unique identity, or principal, to which Kerberos can assign tickets.
kerberos_keytabstringThe Base64 string representation of the Keytab file.
kerberos_krb5_confstringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
tagsarrayAn array of key-value pairs to apply to this resource.
agent_arnsarrayARN(s) of the agent(s) to use for an HDFS location.
subdirectorystringThe subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
location_arnstringThe Amazon Resource Name (ARN) of the HDFS location.
location_uristringThe URL of the HDFS location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_hdfs resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationHdfs,
+datasync:ListTagsForResource
+ +### Update +
+datasync:UpdateLocationHdfs,
+datasync:DescribeLocationHdfs,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```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, +tags, +agent_arns, +subdirectory, +location_arn, +location_uri +FROM awscc.datasync.location_hdfs +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md new file mode 100644 index 0000000000..0c54e3fc08 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md @@ -0,0 +1,80 @@ +--- +title: location_nfs +hide_title: false +hide_table_of_contents: false +keywords: + - location_nfs + - 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 +--- +Gets an individual location_nfs resource + +## Overview + + + + + +
Namelocation_nfs
TypeResource
Descriptionlocation_nfs
Idawscc.datasync.location_nfs
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
mount_optionsobject
on_prem_configobject
server_hostnamestringThe name of the NFS server. This value is the IP address or DNS name of the NFS server.
subdirectorystringThe subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the NFS location.
location_uristringThe URL of the NFS location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_nfs resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationNfs,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationNfs,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource,
+datasync:UpdateLocationNfs
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +mount_options, +on_prem_config, +server_hostname, +subdirectory, +tags, +location_arn, +location_uri +FROM awscc.datasync.location_nfs +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_object_storage/index.md b/docs/awscc-docs/providers/awscc/datasync/location_object_storage/index.md new file mode 100644 index 0000000000..30877247d0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_object_storage/index.md @@ -0,0 +1,90 @@ +--- +title: location_object_storage +hide_title: false +hide_table_of_contents: false +keywords: + - location_object_storage + - 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 +--- +Gets an individual location_object_storage resource + +## Overview + + + + + +
Namelocation_object_storage
TypeResource
Descriptionlocation_object_storage
Idawscc.datasync.location_object_storage
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
access_keystringOptional. The access key is used if credentials are required to access the self-managed object storage server.
agent_arnsarrayThe Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
bucket_namestringThe name of the bucket on the self-managed object storage server.
secret_keystringOptional. The secret key is used if credentials are required to access the self-managed object storage server.
server_certificatestringX.509 PEM content containing a certificate authority or chain to trust.
server_hostnamestringThe 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.
server_portintegerThe port that your self-managed server accepts inbound network traffic on.
server_protocolstringThe protocol that the object storage server uses to communicate.
subdirectorystringThe subdirectory in the self-managed object storage server that is used to read data from.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the location that is created.
location_uristringThe URL of the object storage location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_object_storage resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationObjectStorage,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationObjectStorage,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource,
+datasync:UpdateLocationObjectStorage
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +access_key, +agent_arns, +bucket_name, +secret_key, +server_certificate, +server_hostname, +server_port, +server_protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM awscc.datasync.location_object_storage +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_object_storages/index.md b/docs/awscc-docs/providers/awscc/datasync/location_object_storages/index.md new file mode 100644 index 0000000000..1ed5d155df --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_object_storages/index.md @@ -0,0 +1,61 @@ +--- +title: location_object_storages +hide_title: false +hide_table_of_contents: false +keywords: + - location_object_storages + - 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 +--- +Retrieves a list of location_object_storages in a region + +## Overview + + + + + +
Namelocation_object_storages
TypeResource
Descriptionlocation_object_storages
Idawscc.datasync.location_object_storages
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the location that is created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_object_storages resource, the following permissions are required: + +### Create +
+datasync:CreateLocationObjectStorage,
+datasync:DescribeLocationObjectStorage,
+datasync:ListTagsForResource,
+datasync:TagResource
+ +### List +
+datasync:ListLocations
+ + +## Example +```sql +SELECT +region, +location_arn +FROM awscc.datasync.location_object_storages +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_s3/index.md b/docs/awscc-docs/providers/awscc/datasync/location_s3/index.md new file mode 100644 index 0000000000..b0f354b3f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_s3/index.md @@ -0,0 +1,79 @@ +--- +title: location_s3 +hide_title: false +hide_table_of_contents: false +keywords: + - location_s3 + - 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 +--- +Gets an individual location_s3 resource + +## Overview + + + + + +
Namelocation_s3
TypeResource
Descriptionlocation_s3
Idawscc.datasync.location_s3
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
s3_configobject
s3_bucket_arnstringThe Amazon Resource Name (ARN) of the Amazon S3 bucket.
subdirectorystringA 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.
s3_storage_classstringThe Amazon S3 storage class you want to store your files in when this location is used as a task destination.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
location_uristringThe URL of the S3 location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_s3 resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationS3,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationS3,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +s3_config, +s3_bucket_arn, +subdirectory, +s3_storage_class, +tags, +location_arn, +location_uri +FROM awscc.datasync.location_s3 +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md b/docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md new file mode 100644 index 0000000000..8c85f85332 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md @@ -0,0 +1,65 @@ +--- +title: location_s3s +hide_title: false +hide_table_of_contents: false +keywords: + - location_s3s + - 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 +--- +Retrieves a list of location_s3s in a region + +## Overview + + + + + +
Namelocation_s3s
TypeResource
Descriptionlocation_s3s
Idawscc.datasync.location_s3s
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_s3s resource, the following permissions are required: + +### Create +
+datasync:CreateLocationS3,
+datasync:DescribeLocationS3,
+datasync:ListTagsForResource,
+datasync:TagResource,
+s3:ListAllMyBuckets,
+s3:ListBucket,
+iam:GetRole,
+iam:PassRole
+ +### List +
+datasync:ListLocations
+ + +## Example +```sql +SELECT +region, +location_arn +FROM awscc.datasync.location_s3s +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_smb/index.md b/docs/awscc-docs/providers/awscc/datasync/location_smb/index.md new file mode 100644 index 0000000000..69d9e1942c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_smb/index.md @@ -0,0 +1,86 @@ +--- +title: location_smb +hide_title: false +hide_table_of_contents: false +keywords: + - location_smb + - 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 +--- +Gets an individual location_smb resource + +## Overview + + + + + +
Namelocation_smb
TypeResource
Descriptionlocation_smb
Idawscc.datasync.location_smb
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
agent_arnsarrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
domainstringThe name of the Windows domain that the SMB server belongs to.
mount_optionsobject
passwordstringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
server_hostnamestringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
subdirectorystringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
userstringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the SMB location that is created.
location_uristringThe URL of the SMB location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_smb resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationSmb,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationSmb,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource,
+datasync:UpdateLocationSmb
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +agent_arns, +domain, +mount_options, +password, +server_hostname, +subdirectory, +user, +tags, +location_arn, +location_uri +FROM awscc.datasync.location_smb +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md new file mode 100644 index 0000000000..3b7a751ac8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md @@ -0,0 +1,61 @@ +--- +title: location_smbs +hide_title: false +hide_table_of_contents: false +keywords: + - location_smbs + - 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 +--- +Retrieves a list of location_smbs in a region + +## Overview + + + + + +
Namelocation_smbs
TypeResource
Descriptionlocation_smbs
Idawscc.datasync.location_smbs
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the SMB location that is created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location_smbs resource, the following permissions are required: + +### Create +
+datasync:CreateLocationSmb,
+datasync:DescribeLocationSmb,
+datasync:ListTagsForResource,
+datasync:TagResource
+ +### List +
+datasync:ListLocations
+ + +## Example +```sql +SELECT +region, +location_arn +FROM awscc.datasync.location_smbs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustre/index.md b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustre/index.md new file mode 100644 index 0000000000..7de0103d61 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustre/index.md @@ -0,0 +1,77 @@ +--- +title: locationf_sx_lustre +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_lustre + - 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 +--- +Gets an individual locationf_sx_lustre resource + +## Overview + + + + + +
Namelocationf_sx_lustre
TypeResource
Descriptionlocationf_sx_lustre
Idawscc.datasync.locationf_sx_lustre
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx for Lustre file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx for Lustre file system.
subdirectorystringA subdirectory in the location's path.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
location_uristringThe URL of the FSx for Lustre location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the locationf_sx_lustre resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationFsxLustre,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationFsxLustre,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +subdirectory, +tags, +location_arn, +location_uri +FROM awscc.datasync.locationf_sx_lustre +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustres/index.md b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustres/index.md new file mode 100644 index 0000000000..90060e26cb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustres/index.md @@ -0,0 +1,65 @@ +--- +title: locationf_sx_lustres +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_lustres + - 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 +--- +Retrieves a list of locationf_sx_lustres in a region + +## Overview + + + + + +
Namelocationf_sx_lustres
TypeResource
Descriptionlocationf_sx_lustres
Idawscc.datasync.locationf_sx_lustres
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the locationf_sx_lustres resource, the following permissions are required: + +### Create +
+datasync:CreateLocationFsxLustre,
+datasync:DescribeLocationFsxLustre,
+datasync:ListTagsForResource,
+datasync:TagResource,
+fsx:DescribeFileSystems,
+ec2:DescribeNetworkInterfaces,
+ec2:DescribeSubnets,
+ec2:DescribeSecurityGroups
+ +### List +
+datasync:ListLocations
+ + +## Example +```sql +SELECT +region, +location_arn +FROM awscc.datasync.locationf_sx_lustres +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontap/index.md b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontap/index.md new file mode 100644 index 0000000000..efe7b421c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontap/index.md @@ -0,0 +1,81 @@ +--- +title: locationf_sx_ontap +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_ontap + - 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 +--- +Gets an individual locationf_sx_ontap resource + +## Overview + + + + + +
Namelocationf_sx_ontap
TypeResource
Descriptionlocationf_sx_ontap
Idawscc.datasync.locationf_sx_ontap
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
storage_virtual_machine_arnstringThe Amazon Resource Name (ARN) for the FSx ONTAP SVM.
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx ONAP file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx ONTAP file system.
protocolobject
subdirectorystringA subdirectory in the location's path.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
location_uristringThe URL of the FSx ONTAP file system that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the locationf_sx_ontap resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationFsxOntap,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationFsxOntap,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +storage_virtual_machine_arn, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM awscc.datasync.locationf_sx_ontap +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontaps/index.md b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontaps/index.md new file mode 100644 index 0000000000..87d608a6f3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontaps/index.md @@ -0,0 +1,66 @@ +--- +title: locationf_sx_ontaps +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_ontaps + - 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 +--- +Retrieves a list of locationf_sx_ontaps in a region + +## Overview + + + + + +
Namelocationf_sx_ontaps
TypeResource
Descriptionlocationf_sx_ontaps
Idawscc.datasync.locationf_sx_ontaps
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the locationf_sx_ontaps resource, the following permissions are required: + +### Create +
+datasync:CreateLocationFsxOntap,
+datasync:DescribeLocationFsxOntap,
+datasync:ListTagsForResource,
+datasync:TagResource,
+fsx:DescribeStorageVirtualMachines,
+fsx:DescribeFileSystems,
+ec2:DescribeNetworkInterfaces,
+ec2:DescribeSubnets,
+ec2:DescribeSecurityGroups
+ +### List +
+datasync:ListLocations
+ + +## Example +```sql +SELECT +region, +location_arn +FROM awscc.datasync.locationf_sx_ontaps +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_open_zfs/index.md b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_open_zfs/index.md new file mode 100644 index 0000000000..9df61a67a2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_open_zfs/index.md @@ -0,0 +1,79 @@ +--- +title: locationf_sx_open_zfs +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_open_zfs + - 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 +--- +Gets an individual locationf_sx_open_zfs resource + +## Overview + + + + + +
Namelocationf_sx_open_zfs
TypeResource
Descriptionlocationf_sx_open_zfs
Idawscc.datasync.locationf_sx_open_zfs
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
protocolobject
subdirectorystringA subdirectory in the location's path.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
location_uristringThe URL of the FSx OpenZFS that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the locationf_sx_open_zfs resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationFsxOpenZfs,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationFsxOpenZfs,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM awscc.datasync.locationf_sx_open_zfs +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_windows/index.md b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_windows/index.md new file mode 100644 index 0000000000..ab335fd5a3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/locationf_sx_windows/index.md @@ -0,0 +1,83 @@ +--- +title: locationf_sx_windows +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_windows + - 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 +--- +Gets an individual locationf_sx_windows resource + +## Overview + + + + + +
Namelocationf_sx_windows
TypeResource
Descriptionlocationf_sx_windows
Idawscc.datasync.locationf_sx_windows
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
domainstringThe name of the Windows domain that the FSx for Windows server belongs to.
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx for Windows file system.
passwordstringThe password of the user who has the permissions to access files and folders in the FSx for Windows file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx for Windows file system.
subdirectorystringA subdirectory in the location's path.
userstringThe user who has the permissions to access files and folders in the FSx for Windows file system.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
location_uristringThe URL of the FSx for Windows location that was described.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the locationf_sx_windows resource, the following permissions are required: + +### Read +
+datasync:DescribeLocationFsxWindows,
+datasync:ListTagsForResource
+ +### Update +
+datasync:DescribeLocationFsxWindows,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource
+ +### Delete +
+datasync:DeleteLocation
+ + +## Example +```sql +SELECT +region, +domain, +fsx_filesystem_arn, +password, +security_group_arns, +subdirectory, +user, +tags, +location_arn, +location_uri +FROM awscc.datasync.locationf_sx_windows +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/storage_system/index.md b/docs/awscc-docs/providers/awscc/datasync/storage_system/index.md new file mode 100644 index 0000000000..570959a9f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/storage_system/index.md @@ -0,0 +1,92 @@ +--- +title: storage_system +hide_title: false +hide_table_of_contents: false +keywords: + - storage_system + - 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 +--- +Gets an individual storage_system resource + +## Overview + + + + + +
Namestorage_system
TypeResource
Descriptionstorage_system
Idawscc.datasync.storage_system
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
server_configurationobject
server_credentialsobject
secrets_manager_arnstringThe ARN of a secret stored by AWS Secrets Manager.
system_typestringThe type of on-premises storage system that DataSync Discovery will analyze.
agent_arnsarrayThe ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.
cloud_watch_log_group_arnstringThe ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.
namestringA familiar name for the on-premises storage system.
tagsarrayAn array of key-value pairs to apply to this resource.
storage_system_arnstringThe ARN of the on-premises storage system added to DataSync Discovery.
connectivity_statusstringIndicates whether the DataSync agent can access the on-premises storage system.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the storage_system resource, the following permissions are required: + +### Read +
+datasync:DescribeStorageSystem,
+datasync:ListTagsForResource,
+secretsmanager:DescribeSecret
+ +### Update +
+datasync:UpdateStorageSystem,
+datasync:DescribeStorageSystem,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource,
+secretsmanager:DescribeSecret,
+secretsmanager:PutSecretValue
+ +### Delete +
+datasync:DescribeStorageSystem,
+datasync:RemoveStorageSystem,
+secretsmanager:DescribeSecret,
+secretsmanager:DeleteSecret
+ + +## Example +```sql +SELECT +region, +server_configuration, +server_credentials, +secrets_manager_arn, +system_type, +agent_arns, +cloud_watch_log_group_arn, +name, +tags, +storage_system_arn, +connectivity_status +FROM awscc.datasync.storage_system +WHERE region = 'us-east-1' +AND data__Identifier = '<StorageSystemArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md b/docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md new file mode 100644 index 0000000000..07cc3409a0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md @@ -0,0 +1,64 @@ +--- +title: storage_systems +hide_title: false +hide_table_of_contents: false +keywords: + - storage_systems + - 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 +--- +Retrieves a list of storage_systems in a region + +## Overview + + + + + +
Namestorage_systems
TypeResource
Descriptionstorage_systems
Idawscc.datasync.storage_systems
+ +## Fields + + + + + +
NameDatatypeDescription
storage_system_arnstringThe ARN of the on-premises storage system added to DataSync Discovery.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the storage_systems resource, the following permissions are required: + +### Create +
+datasync:AddStorageSystem,
+datasync:DescribeStorageSystem,
+datasync:ListTagsForResource,
+datasync:TagResource,
+secretsmanager:CreateSecret,
+secretsmanager:DescribeSecret,
+iam:CreateServiceLinkedRole
+ +### List +
+datasync:ListStorageSystems
+ + +## Example +```sql +SELECT +region, +storage_system_arn +FROM awscc.datasync.storage_systems +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/task/index.md b/docs/awscc-docs/providers/awscc/datasync/task/index.md new file mode 100644 index 0000000000..cdda0961a0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/task/index.md @@ -0,0 +1,104 @@ +--- +title: task +hide_title: false +hide_table_of_contents: false +keywords: + - task + - 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 +--- +Gets an individual task resource + +## Overview + + + + + +
Nametask
TypeResource
Descriptiontask
Idawscc.datasync.task
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
excludesarray
includesarray
tagsarrayAn array of key-value pairs to apply to this resource.
cloud_watch_log_group_arnstringThe ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destination_location_arnstringThe ARN of an AWS storage resource's location.
namestringThe name of a task. This value is a text reference that is used to identify the task in the console.
optionsobject
task_report_configobject
scheduleobject
source_location_arnstringThe ARN of the source location for the task.
task_arnstringThe ARN of the task.
statusstringThe status of the task that was described.
source_network_interface_arnsarray
destination_network_interface_arnsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task resource, the following permissions are required: + +### Read +
+datasync:DescribeTask,
+datasync:ListTagsForResource
+ +### Update +
+datasync:UpdateTask,
+datasync:DescribeTask,
+datasync:ListTagsForResource,
+datasync:TagResource,
+datasync:UntagResource,
+logs:DescribeLogGroups,
+iam:PassRole
+ +### Delete +
+datasync:DeleteTask,
+ec2:DescribeNetworkInterfaces,
+ec2:DeleteNetworkInterface,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+fsx:DescribeFileSystems,
+elasticfilesystem:DescribeFileSystems,
+elasticfilesystem:DescribeMountTargets,
+iam:GetRole
+ + +## Example +```sql +SELECT +region, +excludes, +includes, +tags, +cloud_watch_log_group_arn, +destination_location_arn, +name, +options, +task_report_config, +schedule, +source_location_arn, +task_arn, +status, +source_network_interface_arns, +destination_network_interface_arns +FROM awscc.datasync.task +WHERE region = 'us-east-1' +AND data__Identifier = '<TaskArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/datasync/tasks/index.md b/docs/awscc-docs/providers/awscc/datasync/tasks/index.md new file mode 100644 index 0000000000..30986bb4f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datasync/tasks/index.md @@ -0,0 +1,76 @@ +--- +title: tasks +hide_title: false +hide_table_of_contents: false +keywords: + - tasks + - 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 +--- +Retrieves a list of tasks in a region + +## Overview + + + + + +
Nametasks
TypeResource
Descriptiontasks
Idawscc.datasync.tasks
+ +## Fields + + + + + +
NameDatatypeDescription
task_arnstringThe ARN of the task.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tasks resource, the following permissions are required: + +### Create +
+datasync:CreateTask,
+datasync:DescribeTask,
+datasync:ListTagsForResource,
+datasync:TagResource,
+s3:ListAllMyBuckets,
+s3:ListBucket,
+ec2:DescribeNetworkInterfaces,
+ec2:CreateNetworkInterface,
+ec2:DeleteNetworkInterface,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:CreateNetworkInterfacePermission,
+fsx:DescribeFileSystems,
+elasticfilesystem:DescribeFileSystems,
+elasticfilesystem:DescribeMountTargets,
+logs:DescribeLogGroups,
+iam:GetRole,
+iam:PassRole,
+iam:AssumeRole
+ +### List +
+datasync:ListTasks
+ + +## Example +```sql +SELECT +region, +task_arn +FROM awscc.datasync.tasks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/data_source/index.md b/docs/awscc-docs/providers/awscc/datazone/data_source/index.md new file mode 100644 index 0000000000..b2bb5a1bd0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/data_source/index.md @@ -0,0 +1,109 @@ +--- +title: data_source +hide_title: false +hide_table_of_contents: false +keywords: + - data_source + - 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 +--- +Gets an individual data_source resource + +## Overview + + + + + +
Namedata_source
TypeResource
Descriptiondata_source
Idawscc.datazone.data_source
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
asset_forms_inputarrayThe metadata forms that are to be attached to the assets that this data source works with.
created_atstringThe timestamp of when the data source was created.
descriptionstringThe description of the data source.
domain_idstringThe ID of the Amazon DataZone domain where the data source is created.
domain_identifierstringThe ID of the Amazon DataZone domain where the data source is created.
enable_settingstringSpecifies whether the data source is enabled.
environment_idstringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
environment_identifierstringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
idstringThe unique identifier of the data source.
configurationundefinedConfiguration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.
last_run_asset_countnumberThe number of assets created by the data source during its last run.
last_run_atstringThe timestamp that specifies when the data source was last run.
last_run_statusstringThe status of the last run of this data source.
namestringThe name of the data source.
project_idstringThe ID of the Amazon DataZone project to which the data source is added.
project_identifierstringThe identifier of the Amazon DataZone project in which you want to add the data source.
publish_on_importbooleanSpecifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
recommendationobjectSpecifies whether the business name generation is to be enabled for this data source.
scheduleobjectThe schedule of the data source runs.
statusstringThe status of the data source.
typestringThe type of the data source.
updated_atstringThe timestamp of when this data source was updated.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_source resource, the following permissions are required: + +### Read +
+datazone:GetDataSource
+ +### Update +
+datazone:UpdateDataSource,
+datazone:GetDataSource,
+datazone:DeleteDataSource
+ +### Delete +
+datazone:DeleteDataSource,
+datazone:GetDataSource
+ + +## Example +```sql +SELECT +region, +asset_forms_input, +created_at, +description, +domain_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 awscc.datazone.data_source +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/data_sources/index.md b/docs/awscc-docs/providers/awscc/datazone/data_sources/index.md new file mode 100644 index 0000000000..a8c86a54b7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/data_sources/index.md @@ -0,0 +1,63 @@ +--- +title: data_sources +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources + - 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 +--- +Retrieves a list of data_sources in a region + +## Overview + + + + + +
Namedata_sources
TypeResource
Descriptiondata_sources
Idawscc.datazone.data_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstringThe ID of the Amazon DataZone domain where the data source is created.
idstringThe unique identifier of the data source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +
+datazone:CreateDataSource,
+iam:PassRole,
+datazone:GetDataSource,
+datazone:DeleteDataSource
+ +### List +
+datazone:ListDataSources
+ + +## Example +```sql +SELECT +region, +domain_id, +id +FROM awscc.datazone.data_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/domain/index.md b/docs/awscc-docs/providers/awscc/datazone/domain/index.md new file mode 100644 index 0000000000..d47d32c18f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/domain/index.md @@ -0,0 +1,94 @@ +--- +title: domain +hide_title: false +hide_table_of_contents: false +keywords: + - domain + - 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 +--- +Gets an individual domain resource + +## Overview + + + + + +
Namedomain
TypeResource
Descriptiondomain
Idawscc.datazone.domain
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the Amazon DataZone domain.
created_atstringThe timestamp of when the Amazon DataZone domain was last updated.
descriptionstringThe description of the Amazon DataZone domain.
domain_execution_rolestringThe 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.
idstringThe id of the Amazon DataZone domain.
kms_key_identifierstringThe identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
last_updated_atstringThe timestamp of when the Amazon DataZone domain was last updated.
managed_account_idstringThe identifier of the AWS account that manages the domain.
namestringThe name of the Amazon DataZone domain.
portal_urlstringThe URL of the data portal for this Amazon DataZone domain.
single_sign_onobjectThe single-sign on configuration of the Amazon DataZone domain.
statusstringThe status of the Amazon DataZone domain.
tagsarrayThe tags specified for the Amazon DataZone domain.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +
+datazone:GetDomain
+ +### Update +
+datazone:UpdateDomain,
+datazone:GetDomain,
+datazone:TagResource,
+datazone:UntagResource,
+sso:CreateManagedApplicationInstance,
+sso:DeleteManagedApplicationInstance,
+sso:PutApplicationAssignmentConfiguration
+ +### Delete +
+datazone:DeleteDomain,
+datazone:GetDomain
+ + +## Example +```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, +tags +FROM awscc.datazone.domain +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/domains/index.md b/docs/awscc-docs/providers/awscc/datazone/domains/index.md new file mode 100644 index 0000000000..b4353c3cd1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/domains/index.md @@ -0,0 +1,64 @@ +--- +title: domains +hide_title: false +hide_table_of_contents: false +keywords: + - domains + - 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 +--- +Retrieves a list of domains in a region + +## Overview + + + + + +
Namedomains
TypeResource
Descriptiondomains
Idawscc.datazone.domains
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe id of the Amazon DataZone domain.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +
+datazone:CreateDomain,
+datazone:UpdateDomain,
+datazone:GetDomain,
+datazone:TagResource,
+sso:CreateManagedApplicationInstance,
+sso:DeleteManagedApplicationInstance,
+sso:PutApplicationAssignmentConfiguration
+ +### List +
+datazone:ListDomains
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.datazone.domains +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/environment/index.md b/docs/awscc-docs/providers/awscc/datazone/environment/index.md new file mode 100644 index 0000000000..f1fc579a63 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/environment/index.md @@ -0,0 +1,103 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.datazone.environment
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
aws_account_idstringThe AWS account in which the Amazon DataZone environment is created.
aws_account_regionstringThe AWS region in which the Amazon DataZone environment is created.
created_atstringThe timestamp of when the environment was created.
created_bystringThe Amazon DataZone user who created the environment.
descriptionstringThe description of the Amazon DataZone environment.
domain_idstringThe identifier of the Amazon DataZone domain in which the environment is created.
domain_identifierstringThe identifier of the Amazon DataZone domain in which the environment would be created.
environment_blueprint_idstringThe ID of the blueprint with which the Amazon DataZone environment was created.
environment_profile_idstringThe ID of the environment profile with which the Amazon DataZone environment was created.
environment_profile_identifierstringThe ID of the environment profile with which the Amazon DataZone environment would be created.
glossary_termsarrayThe glossary terms that can be used in the Amazon DataZone environment.
idstringThe ID of the Amazon DataZone environment.
namestringThe name of the environment.
project_idstringThe ID of the Amazon DataZone project in which the environment is created.
project_identifierstringThe ID of the Amazon DataZone project in which the environment would be created.
providerstringThe provider of the Amazon DataZone environment.
statusstringThe status of the Amazon DataZone environment.
updated_atstringThe timestamp of when the environment was updated.
user_parametersarrayThe user parameters of the Amazon DataZone environment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+datazone:GetEnvironment
+ +### Update +
+datazone:UpdateEnvironment,
+datazone:GetEnvironment,
+datazone:DeleteEnvironment
+ +### Delete +
+datazone:DeleteEnvironment,
+datazone:GetEnvironment
+ + +## Example +```sql +SELECT +region, +aws_account_id, +aws_account_region, +created_at, +created_by, +description, +domain_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 awscc.datazone.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configuration/index.md b/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configuration/index.md new file mode 100644 index 0000000000..84724591bf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configuration/index.md @@ -0,0 +1,86 @@ +--- +title: environment_blueprint_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - environment_blueprint_configuration + - 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 +--- +Gets an individual environment_blueprint_configuration resource + +## Overview + + + + + +
Nameenvironment_blueprint_configuration
TypeResource
Descriptionenvironment_blueprint_configuration
Idawscc.datazone.environment_blueprint_configuration
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
regional_parametersarray
provisioning_role_arnstring
domain_idstring
created_atstring
enabled_regionsarray
environment_blueprint_identifierstring
environment_blueprint_idstring
updated_atstring
domain_identifierstring
manage_access_role_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_blueprint_configuration resource, the following permissions are required: + +### Read +
+datazone:GetEnvironmentBlueprintConfiguration
+ +### Update +
+datazone:DeleteEnvironmentBlueprintConfiguration,
+iam:PassRole,
+datazone:GetEnvironmentBlueprintConfiguration,
+datazone:PutEnvironmentBlueprintConfiguration
+ +### Delete +
+datazone:GetEnvironmentBlueprintConfiguration,
+datazone:DeleteEnvironmentBlueprintConfiguration
+ + +## Example +```sql +SELECT +region, +regional_parameters, +provisioning_role_arn, +domain_id, +created_at, +enabled_regions, +environment_blueprint_identifier, +environment_blueprint_id, +updated_at, +domain_identifier, +manage_access_role_arn +FROM awscc.datazone.environment_blueprint_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<EnvironmentBlueprintId>' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configurations/index.md b/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configurations/index.md new file mode 100644 index 0000000000..92025c1ee1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configurations/index.md @@ -0,0 +1,63 @@ +--- +title: environment_blueprint_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - environment_blueprint_configurations + - 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 +--- +Retrieves a list of environment_blueprint_configurations in a region + +## Overview + + + + + +
Nameenvironment_blueprint_configurations
TypeResource
Descriptionenvironment_blueprint_configurations
Idawscc.datazone.environment_blueprint_configurations
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstring
environment_blueprint_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_blueprint_configurations resource, the following permissions are required: + +### Create +
+datazone:ListEnvironmentBlueprints,
+iam:PassRole,
+datazone:GetEnvironmentBlueprintConfiguration,
+datazone:PutEnvironmentBlueprintConfiguration
+ +### List +
+datazone:ListEnvironmentBlueprintConfigurations
+ + +## Example +```sql +SELECT +region, +domain_id, +environment_blueprint_id +FROM awscc.datazone.environment_blueprint_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md b/docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md new file mode 100644 index 0000000000..6699a98604 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md @@ -0,0 +1,94 @@ +--- +title: environment_profile +hide_title: false +hide_table_of_contents: false +keywords: + - environment_profile + - 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 +--- +Gets an individual environment_profile resource + +## Overview + + + + + +
Nameenvironment_profile
TypeResource
Descriptionenvironment_profile
Idawscc.datazone.environment_profile
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
aws_account_idstringThe AWS account in which the Amazon DataZone environment is created.
aws_account_regionstringThe AWS region in which this environment profile is created.
created_atstringThe timestamp of when this environment profile was created.
created_bystringThe Amazon DataZone user who created this environment profile.
descriptionstringThe description of this Amazon DataZone environment profile.
domain_idstringThe ID of the Amazon DataZone domain in which this environment profile is created.
domain_identifierstringThe ID of the Amazon DataZone domain in which this environment profile is created.
environment_blueprint_idstringThe ID of the blueprint with which this environment profile is created.
environment_blueprint_identifierstringThe ID of the blueprint with which this environment profile is created.
idstringThe ID of this Amazon DataZone environment profile.
namestringThe name of this Amazon DataZone environment profile.
project_idstringThe identifier of the project in which to create the environment profile.
project_identifierstringThe identifier of the project in which to create the environment profile.
updated_atstringThe timestamp of when this environment profile was updated.
user_parametersarrayThe user parameters of this Amazon DataZone environment profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_profile resource, the following permissions are required: + +### Read +
+datazone:GetEnvironmentProfile
+ +### Update +
+datazone:UpdateEnvironmentProfile,
+datazone:GetEnvironmentProfile
+ +### Delete +
+datazone:DeleteEnvironmentProfile,
+datazone:GetEnvironmentProfile
+ + +## Example +```sql +SELECT +region, +aws_account_id, +aws_account_region, +created_at, +created_by, +description, +domain_id, +domain_identifier, +environment_blueprint_id, +environment_blueprint_identifier, +id, +name, +project_id, +project_identifier, +updated_at, +user_parameters +FROM awscc.datazone.environment_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md b/docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md new file mode 100644 index 0000000000..ce6a890487 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md @@ -0,0 +1,61 @@ +--- +title: environment_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - environment_profiles + - 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 +--- +Retrieves a list of environment_profiles in a region + +## Overview + + + + + +
Nameenvironment_profiles
TypeResource
Descriptionenvironment_profiles
Idawscc.datazone.environment_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstringThe ID of the Amazon DataZone domain in which this environment profile is created.
idstringThe ID of this Amazon DataZone environment profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_profiles resource, the following permissions are required: + +### Create +
+datazone:CreateEnvironmentProfile,
+datazone:GetEnvironmentProfile
+ +### List +
+datazone:ListEnvironmentProfiles
+ + +## Example +```sql +SELECT +region, +domain_id, +id +FROM awscc.datazone.environment_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/environments/index.md b/docs/awscc-docs/providers/awscc/datazone/environments/index.md new file mode 100644 index 0000000000..671ba67475 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/environments/index.md @@ -0,0 +1,62 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.datazone.environments
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstringThe identifier of the Amazon DataZone domain in which the environment is created.
idstringThe ID of the Amazon DataZone environment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+datazone:CreateEnvironment,
+datazone:GetEnvironment,
+datazone:DeleteEnvironment
+ +### List +
+datazone:ListEnvironments
+ + +## Example +```sql +SELECT +region, +domain_id, +id +FROM awscc.datazone.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/index.md b/docs/awscc-docs/providers/awscc/datazone/index.md new file mode 100644 index 0000000000..7c4e2cc7ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/index.md @@ -0,0 +1,51 @@ +--- +title: datazone +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The datazone service documentation. + +:::info Service Summary + +
+
+total resources: 14
+total selectable resources: 14
+total methods: 14
+
+
+ +::: + +## Resources +
+
+data_source
+data_sources
+domain
+domains
+environment
+environment_blueprint_configuration
+environment_blueprint_configurations +
+
+environment_profile
+environment_profiles
+environments
+project
+projects
+subscription_target
+subscription_targets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/datazone/project/index.md b/docs/awscc-docs/providers/awscc/datazone/project/index.md new file mode 100644 index 0000000000..3f6066cd4a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/project/index.md @@ -0,0 +1,82 @@ +--- +title: project +hide_title: false +hide_table_of_contents: false +keywords: + - project + - 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 +--- +Gets an individual project resource + +## Overview + + + + + +
Nameproject
TypeResource
Descriptionproject
Idawscc.datazone.project
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
created_atstringThe timestamp of when the project was created.
created_bystringThe Amazon DataZone user who created the project.
descriptionstringThe description of the Amazon DataZone project.
domain_idstringThe identifier of the Amazon DataZone domain in which the project was created.
domain_identifierstringThe ID of the Amazon DataZone domain in which this project is created.
glossary_termsarrayThe glossary terms that can be used in this Amazon DataZone project.
idstringThe ID of the Amazon DataZone project.
last_updated_atstringThe timestamp of when the project was last updated.
namestringThe name of the Amazon DataZone project.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +
+datazone:GetProject
+ +### Update +
+datazone:UpdateProject,
+datazone:GetProject
+ +### Delete +
+datazone:DeleteProject,
+datazone:GetProject
+ + +## Example +```sql +SELECT +region, +created_at, +created_by, +description, +domain_id, +domain_identifier, +glossary_terms, +id, +last_updated_at, +name +FROM awscc.datazone.project +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/projects/index.md b/docs/awscc-docs/providers/awscc/datazone/projects/index.md new file mode 100644 index 0000000000..57e27346b6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/projects/index.md @@ -0,0 +1,61 @@ +--- +title: projects +hide_title: false +hide_table_of_contents: false +keywords: + - projects + - 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 +--- +Retrieves a list of projects in a region + +## Overview + + + + + +
Nameprojects
TypeResource
Descriptionprojects
Idawscc.datazone.projects
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstringThe identifier of the Amazon DataZone domain in which the project was created.
idstringThe ID of the Amazon DataZone project.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +
+datazone:CreateProject,
+datazone:GetProject
+ +### List +
+datazone:ListProjects
+ + +## Example +```sql +SELECT +region, +domain_id, +id +FROM awscc.datazone.projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md b/docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md new file mode 100644 index 0000000000..fcf76fe5db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md @@ -0,0 +1,99 @@ +--- +title: subscription_target +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_target + - 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 +--- +Gets an individual subscription_target resource + +## Overview + + + + + +
Namesubscription_target
TypeResource
Descriptionsubscription_target
Idawscc.datazone.subscription_target
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
applicable_asset_typesarrayThe asset types that can be included in the subscription target.
authorized_principalsarrayThe authorized principals of the subscription target.
created_atstringThe timestamp of when the subscription target was created.
created_bystringThe Amazon DataZone user who created the subscription target.
domain_idstringThe ID of the Amazon DataZone domain in which subscription target is created.
domain_identifierstringThe ID of the Amazon DataZone domain in which subscription target would be created.
environment_idstringThe ID of the environment in which subscription target is created.
environment_identifierstringThe ID of the environment in which subscription target would be created.
idstringThe ID of the subscription target.
manage_access_rolestringThe manage access role that is used to create the subscription target.
namestringThe name of the subscription target.
project_idstringThe identifier of the project specified in the subscription target.
providerstringThe provider of the subscription target.
subscription_target_configarrayThe configuration of the subscription target.
typestringThe type of the subscription target.
updated_atstringThe timestamp of when the subscription target was updated.
updated_bystringThe Amazon DataZone user who updated the subscription target.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subscription_target resource, the following permissions are required: + +### Read +
+datazone:GetSubscriptionTarget
+ +### Update +
+datazone:UpdateSubscriptionTarget,
+datazone:GetSubscriptionTarget,
+iam:PassRole
+ +### Delete +
+datazone:DeleteSubscriptionTarget
+ + +## Example +```sql +SELECT +region, +applicable_asset_types, +authorized_principals, +created_at, +created_by, +domain_id, +domain_identifier, +environment_id, +environment_identifier, +id, +manage_access_role, +name, +project_id, +provider, +subscription_target_config, +type, +updated_at, +updated_by +FROM awscc.datazone.subscription_target +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<EnvironmentId>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md b/docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md new file mode 100644 index 0000000000..52b2ae22f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md @@ -0,0 +1,64 @@ +--- +title: subscription_targets +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_targets + - 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 +--- +Retrieves a list of subscription_targets in a region + +## Overview + + + + + +
Namesubscription_targets
TypeResource
Descriptionsubscription_targets
Idawscc.datazone.subscription_targets
+ +## Fields + + + + + + + +
NameDatatypeDescription
domain_idstringThe ID of the Amazon DataZone domain in which subscription target is created.
environment_idstringThe ID of the environment in which subscription target is created.
idstringThe ID of the subscription target.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subscription_targets resource, the following permissions are required: + +### Create +
+datazone:CreateSubscriptionTarget,
+datazone:GetSubscriptionTarget,
+iam:PassRole
+ +### List +
+datazone:ListSubscriptionTargets
+ + +## Example +```sql +SELECT +region, +domain_id, +environment_id, +id +FROM awscc.datazone.subscription_targets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/detective/graph/index.md b/docs/awscc-docs/providers/awscc/detective/graph/index.md new file mode 100644 index 0000000000..2dc3771cc1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/detective/graph/index.md @@ -0,0 +1,74 @@ +--- +title: graph +hide_title: false +hide_table_of_contents: false +keywords: + - graph + - 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 +--- +Gets an individual graph resource + +## Overview + + + + + +
Namegraph
TypeResource
Descriptiongraph
Idawscc.detective.graph
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstringThe Detective graph ARN
tagsarray
auto_enable_membersbooleanIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the graph resource, the following permissions are required: + +### Update +
+detective:UntagResource,
+detective:TagResource,
+detective:ListTagsForResource,
+detective:UpdateOrganizationConfiguration,
+organizations:DescribeOrganization
+ +### Read +
+detective:ListGraphs,
+detective:ListTagsForResource,
+detective:DescribeOrganizationConfiguration,
+organizations:DescribeOrganization
+ +### Delete +
+detective:DeleteGraph
+ + +## Example +```sql +SELECT +region, +arn, +tags, +auto_enable_members +FROM awscc.detective.graph +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/detective/graphs/index.md b/docs/awscc-docs/providers/awscc/detective/graphs/index.md new file mode 100644 index 0000000000..d011de2ce6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/detective/graphs/index.md @@ -0,0 +1,63 @@ +--- +title: graphs +hide_title: false +hide_table_of_contents: false +keywords: + - graphs + - 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 +--- +Retrieves a list of graphs in a region + +## Overview + + + + + +
Namegraphs
TypeResource
Descriptiongraphs
Idawscc.detective.graphs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Detective graph ARN
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the graphs resource, the following permissions are required: + +### Create +
+detective:CreateGraph,
+detective:UpdateOrganizationConfiguration,
+organizations:DescribeOrganization
+ +### List +
+detective:ListGraphs,
+detective:ListTagsForResource,
+detective:DescribeOrganizationConfiguration,
+organizations:DescribeOrganization
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.detective.graphs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/detective/index.md b/docs/awscc-docs/providers/awscc/detective/index.md new file mode 100644 index 0000000000..683cd10f8a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/detective/index.md @@ -0,0 +1,43 @@ +--- +title: detective +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The detective service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+graph
+graphs
+member_invitation +
+
+member_invitations
+organization_admin
+organization_admins +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/detective/member_invitation/index.md b/docs/awscc-docs/providers/awscc/detective/member_invitation/index.md new file mode 100644 index 0000000000..1a3cb06aeb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/detective/member_invitation/index.md @@ -0,0 +1,72 @@ +--- +title: member_invitation +hide_title: false +hide_table_of_contents: false +keywords: + - member_invitation + - 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 +--- +Gets an individual member_invitation resource + +## Overview + + + + + +
Namemember_invitation
TypeResource
Descriptionmember_invitation
Idawscc.detective.member_invitation
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
graph_arnstringThe ARN of the graph to which the member account will be invited
member_idstringThe AWS account ID to be invited to join the graph as a member
member_email_addressstringThe root email address for the account to be invited, for validation. Updating this field has no effect.
disable_email_notificationbooleanWhen 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.
messagestringA message to be included in the email invitation sent to the invited account. Updating this field has no effect.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the member_invitation resource, the following permissions are required: + +### Read +
+detective:GetMembers
+ +### Update +
+
+ +### Delete +
+detective:DeleteMembers
+ + +## Example +```sql +SELECT +region, +graph_arn, +member_id, +member_email_address, +disable_email_notification, +message +FROM awscc.detective.member_invitation +WHERE region = 'us-east-1' +AND data__Identifier = '<GraphArn>' +AND data__Identifier = '<MemberId>' +``` diff --git a/docs/awscc-docs/providers/awscc/detective/member_invitations/index.md b/docs/awscc-docs/providers/awscc/detective/member_invitations/index.md new file mode 100644 index 0000000000..53c4fb4430 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/detective/member_invitations/index.md @@ -0,0 +1,62 @@ +--- +title: member_invitations +hide_title: false +hide_table_of_contents: false +keywords: + - member_invitations + - 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 +--- +Retrieves a list of member_invitations in a region + +## Overview + + + + + +
Namemember_invitations
TypeResource
Descriptionmember_invitations
Idawscc.detective.member_invitations
+ +## Fields + + + + + + +
NameDatatypeDescription
graph_arnstringThe ARN of the graph to which the member account will be invited
member_idstringThe AWS account ID to be invited to join the graph as a member
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the member_invitations resource, the following permissions are required: + +### Create +
+detective:CreateMembers,
+detective:GetMembers
+ +### List +
+detective:ListGraphs,
+detective:ListMembers
+ + +## Example +```sql +SELECT +region, +graph_arn, +member_id +FROM awscc.detective.member_invitations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/detective/organization_admin/index.md b/docs/awscc-docs/providers/awscc/detective/organization_admin/index.md new file mode 100644 index 0000000000..e15c11ca7e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/detective/organization_admin/index.md @@ -0,0 +1,68 @@ +--- +title: organization_admin +hide_title: false +hide_table_of_contents: false +keywords: + - organization_admin + - 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 +--- +Gets an individual organization_admin resource + +## Overview + + + + + +
Nameorganization_admin
TypeResource
Descriptionorganization_admin
Idawscc.detective.organization_admin
+ +## Fields + + + + + + +
NameDatatypeDescription
account_idstringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
graph_arnstringThe Detective graph ARN
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organization_admin resource, the following permissions are required: + +### Read +
+detective:ListOrganizationAdminAccount,
+organizations:DescribeOrganization
+ +### Update +
+
+ +### Delete +
+detective:DisableOrganizationAdminAccount,
+detective:ListOrganizationAdminAccount,
+organizations:DescribeOrganization
+ + +## Example +```sql +SELECT +region, +account_id, +graph_arn +FROM awscc.detective.organization_admin +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/detective/organization_admins/index.md b/docs/awscc-docs/providers/awscc/detective/organization_admins/index.md new file mode 100644 index 0000000000..84cd7949ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/detective/organization_admins/index.md @@ -0,0 +1,65 @@ +--- +title: organization_admins +hide_title: false +hide_table_of_contents: false +keywords: + - organization_admins + - 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 +--- +Retrieves a list of organization_admins in a region + +## Overview + + + + + +
Nameorganization_admins
TypeResource
Descriptionorganization_admins
Idawscc.detective.organization_admins
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organization_admins resource, the following permissions are required: + +### Create +
+detective:EnableOrganizationAdminAccount,
+detective:ListOrganizationAdminAccount,
+iam:CreateServiceLinkedRole,
+organizations:RegisterDelegatedAdministrator,
+organizations:DescribeOrganization,
+organizations:EnableAWSServiceAccess,
+organizations:ListAccounts
+ +### List +
+detective:ListOrganizationAdminAccount,
+organizations:DescribeOrganization
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.detective.organization_admins +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/devopsguru/index.md b/docs/awscc-docs/providers/awscc/devopsguru/index.md new file mode 100644 index 0000000000..c07a1fab50 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/devopsguru/index.md @@ -0,0 +1,43 @@ +--- +title: devopsguru +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The devopsguru service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+log_anomaly_detection_integration
+log_anomaly_detection_integrations
+notification_channel +
+
+notification_channels
+resource_collection
+resource_collections +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integration/index.md b/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integration/index.md new file mode 100644 index 0000000000..6b18f15d35 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integration/index.md @@ -0,0 +1,68 @@ +--- +title: log_anomaly_detection_integration +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detection_integration + - 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 +--- +Gets an individual log_anomaly_detection_integration resource + +## Overview + + + + + +
Namelog_anomaly_detection_integration
TypeResource
Descriptionlog_anomaly_detection_integration
Idawscc.devopsguru.log_anomaly_detection_integration
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_anomaly_detection_integration resource, the following permissions are required: + +### Read +
+devops-guru:DescribeServiceIntegration
+ +### Update +
+devops-guru:UpdateServiceIntegration,
+logs:TagLogGroup,
+logs:UntagLogGroup
+ +### Delete +
+devops-guru:DescribeServiceIntegration,
+devops-guru:UpdateServiceIntegration,
+logs:TagLogGroup,
+logs:UntagLogGroup
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.devopsguru.log_anomaly_detection_integration +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integrations/index.md b/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integrations/index.md new file mode 100644 index 0000000000..82b3498b99 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integrations/index.md @@ -0,0 +1,61 @@ +--- +title: log_anomaly_detection_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detection_integrations + - 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 +--- +Retrieves a list of log_anomaly_detection_integrations in a region + +## Overview + + + + + +
Namelog_anomaly_detection_integrations
TypeResource
Descriptionlog_anomaly_detection_integrations
Idawscc.devopsguru.log_anomaly_detection_integrations
+ +## Fields + + + + + +
NameDatatypeDescription
account_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_anomaly_detection_integrations resource, the following permissions are required: + +### Create +
+devops-guru:DescribeServiceIntegration,
+devops-guru:UpdateServiceIntegration,
+logs:TagLogGroup,
+logs:UntagLogGroup
+ +### List +
+devops-guru:DescribeServiceIntegration
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.devopsguru.log_anomaly_detection_integrations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md b/docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md new file mode 100644 index 0000000000..a2e8ed9e69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md @@ -0,0 +1,62 @@ +--- +title: notification_channel +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channel + - 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 +--- +Gets an individual notification_channel resource + +## Overview + + + + + +
Namenotification_channel
TypeResource
Descriptionnotification_channel
Idawscc.devopsguru.notification_channel
+ +## Fields + + + + + + +
NameDatatypeDescription
configobject
idstringThe ID of a notification channel.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the notification_channel resource, the following permissions are required: + +### Delete +
+devops-guru:RemoveNotificationChannel,
+devops-guru:ListNotificationChannels
+ +### Read +
+devops-guru:ListNotificationChannels
+ + +## Example +```sql +SELECT +region, +config, +id +FROM awscc.devopsguru.notification_channel +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md b/docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md new file mode 100644 index 0000000000..03044b80c9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md @@ -0,0 +1,62 @@ +--- +title: notification_channels +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channels + - 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 +--- +Retrieves a list of notification_channels in a region + +## Overview + + + + + +
Namenotification_channels
TypeResource
Descriptionnotification_channels
Idawscc.devopsguru.notification_channels
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of a notification channel.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the notification_channels resource, the following permissions are required: + +### Create +
+devops-guru:AddNotificationChannel,
+devops-guru:ListNotificationChannels,
+sns:Publish,
+sns:GetTopicAttributes,
+sns:SetTopicAttributes
+ +### List +
+devops-guru:ListNotificationChannels
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.devopsguru.notification_channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md b/docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md new file mode 100644 index 0000000000..4ed4ee0c8a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md @@ -0,0 +1,67 @@ +--- +title: resource_collection +hide_title: false +hide_table_of_contents: false +keywords: + - resource_collection + - 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 +--- +Gets an individual resource_collection resource + +## Overview + + + + + +
Nameresource_collection
TypeResource
Descriptionresource_collection
Idawscc.devopsguru.resource_collection
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_collection_filterobject
resource_collection_typestringThe type of ResourceCollection
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_collection resource, the following permissions are required: + +### Read +
+devops-guru:GetResourceCollection
+ +### Delete +
+devops-guru:UpdateResourceCollection,
+devops-guru:GetResourceCollection
+ +### Update +
+devops-guru:UpdateResourceCollection,
+devops-guru:GetResourceCollection
+ + +## Example +```sql +SELECT +region, +resource_collection_filter, +resource_collection_type +FROM awscc.devopsguru.resource_collection +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceCollectionType>' +``` diff --git a/docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md b/docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md new file mode 100644 index 0000000000..5a0698fe0b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md @@ -0,0 +1,59 @@ +--- +title: resource_collections +hide_title: false +hide_table_of_contents: false +keywords: + - resource_collections + - 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 +--- +Retrieves a list of resource_collections in a region + +## Overview + + + + + +
Nameresource_collections
TypeResource
Descriptionresource_collections
Idawscc.devopsguru.resource_collections
+ +## Fields + + + + + +
NameDatatypeDescription
resource_collection_typestringThe type of ResourceCollection
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_collections resource, the following permissions are required: + +### Create +
+devops-guru:UpdateResourceCollection,
+devops-guru:GetResourceCollection
+ +### List +
+devops-guru:GetResourceCollection
+ + +## Example +```sql +SELECT +region, +resource_collection_type +FROM awscc.devopsguru.resource_collections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/directoryservice/index.md b/docs/awscc-docs/providers/awscc/directoryservice/index.md new file mode 100644 index 0000000000..9fb0486997 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/directoryservice/index.md @@ -0,0 +1,39 @@ +--- +title: directoryservice +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The directoryservice service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+simple_ad +
+
+simple_ads +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/directoryservice/simple_ad/index.md b/docs/awscc-docs/providers/awscc/directoryservice/simple_ad/index.md new file mode 100644 index 0000000000..656546baa5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/directoryservice/simple_ad/index.md @@ -0,0 +1,92 @@ +--- +title: simple_ad +hide_title: false +hide_table_of_contents: false +keywords: + - simple_ad + - 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 +--- +Gets an individual simple_ad resource + +## Overview + + + + + +
Namesimple_ad
TypeResource
Descriptionsimple_ad
Idawscc.directoryservice.simple_ad
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
directory_idstringThe unique identifier for a directory.
aliasstringThe alias for a directory.
dns_ip_addressesarrayThe IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
create_aliasbooleanThe name of the configuration set.
descriptionstringDescription for the directory.
enable_ssobooleanWhether to enable single sign-on for a Simple Active Directory in AWS.
namestringThe fully qualified domain name for the AWS Managed Simple AD directory.
passwordstringThe password for the default administrative user named Admin.
short_namestringThe NetBIOS name for your domain.
sizestringThe size of the directory.
vpc_settingsobjectVPC settings of the Simple AD directory server in AWS.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simple_ad resource, the following permissions are required: + +### Read +
+ds:DescribeDirectories
+ +### Update +
+ds:EnableSso,
+ds:DisableSso,
+ds:DescribeDirectories
+ +### Delete +
+ds:DeleteDirectory,
+ds:DescribeDirectories,
+ec2:DescribeNetworkInterfaces,
+ec2:DeleteSecurityGroup,
+ec2:DeleteNetworkInterface,
+ec2:RevokeSecurityGroupIngress,
+ec2:RevokeSecurityGroupEgress,
+ec2:DeleteTags
+ + +## Example +```sql +SELECT +region, +directory_id, +alias, +dns_ip_addresses, +create_alias, +description, +enable_sso, +name, +password, +short_name, +size, +vpc_settings +FROM awscc.directoryservice.simple_ad +WHERE region = 'us-east-1' +AND data__Identifier = '<DirectoryId>' +``` diff --git a/docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md b/docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md new file mode 100644 index 0000000000..9af5fe34a9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md @@ -0,0 +1,69 @@ +--- +title: simple_ads +hide_title: false +hide_table_of_contents: false +keywords: + - simple_ads + - 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 +--- +Retrieves a list of simple_ads in a region + +## Overview + + + + + +
Namesimple_ads
TypeResource
Descriptionsimple_ads
Idawscc.directoryservice.simple_ads
+ +## Fields + + + + + +
NameDatatypeDescription
directory_idstringThe unique identifier for a directory.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simple_ads resource, the following permissions are required: + +### Create +
+ds:CreateDirectory,
+ds:CreateAlias,
+ds:EnableSso,
+ds:DescribeDirectories,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+ec2:CreateSecurityGroup,
+ec2:CreateNetworkInterface,
+ec2:DescribeNetworkInterfaces,
+ec2:AuthorizeSecurityGroupIngress,
+ec2:AuthorizeSecurityGroupEgress,
+ec2:CreateTags
+ +### List +
+ds:DescribeDirectories
+ + +## Example +```sql +SELECT +region, +directory_id +FROM awscc.directoryservice.simple_ads +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/data_provider/index.md b/docs/awscc-docs/providers/awscc/dms/data_provider/index.md new file mode 100644 index 0000000000..e95ce3c514 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/data_provider/index.md @@ -0,0 +1,85 @@ +--- +title: data_provider +hide_title: false +hide_table_of_contents: false +keywords: + - data_provider + - 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 +--- +Gets an individual data_provider resource + +## Overview + + + + + +
Namedata_provider
TypeResource
Descriptiondata_provider
Idawscc.dms.data_provider
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
data_provider_namestringThe property describes a name to identify the data provider.
data_provider_identifierstringThe property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn
data_provider_arnstringThe data provider ARN.
data_provider_creation_timestringThe data provider creation time.
descriptionstringThe optional description of the data provider.
enginestringThe property describes a data engine for the data provider.
exact_settingsbooleanThe property describes the exact settings which can be modified
settingsobjectThe property identifies the exact type of settings for the data provider.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_provider resource, the following permissions are required: + +### Read +
+dms:ListDataProviders,
+dms:DescribeDataProviders,
+dms:ListTagsForResource
+ +### Update +
+dms:UpdateDataProvider,
+dms:ModifyDataProvider,
+dms:AddTagsToResource,
+dms:RemoveTagsToResource,
+dms:ListTagsForResource
+ +### Delete +
+dms:DeleteDataProvider
+ + +## Example +```sql +SELECT +region, +data_provider_name, +data_provider_identifier, +data_provider_arn, +data_provider_creation_time, +description, +engine, +exact_settings, +settings, +tags +FROM awscc.dms.data_provider +WHERE region = 'us-east-1' +AND data__Identifier = '<DataProviderArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/data_providers/index.md b/docs/awscc-docs/providers/awscc/dms/data_providers/index.md new file mode 100644 index 0000000000..8f727bbb11 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/data_providers/index.md @@ -0,0 +1,64 @@ +--- +title: data_providers +hide_title: false +hide_table_of_contents: false +keywords: + - data_providers + - 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 +--- +Retrieves a list of data_providers in a region + +## Overview + + + + + +
Namedata_providers
TypeResource
Descriptiondata_providers
Idawscc.dms.data_providers
+ +## Fields + + + + + +
NameDatatypeDescription
data_provider_arnstringThe data provider ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_providers resource, the following permissions are required: + +### Create +
+dms:CreateDataProvider,
+dms:ListDataProviders,
+dms:DescribeDataProviders,
+dms:AddTagsToResource,
+dms:ListTagsForResource
+ +### List +
+dms:ListDataProviders,
+dms:DescribeDataProviders,
+dms:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +data_provider_arn +FROM awscc.dms.data_providers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/index.md b/docs/awscc-docs/providers/awscc/dms/index.md new file mode 100644 index 0000000000..adeb267b1c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/index.md @@ -0,0 +1,45 @@ +--- +title: dms +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The dms service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+data_provider
+data_providers
+instance_profile
+instance_profiles +
+
+migration_project
+migration_projects
+replication_config
+replication_configs +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/dms/instance_profile/index.md b/docs/awscc-docs/providers/awscc/dms/instance_profile/index.md new file mode 100644 index 0000000000..7ab49c6bc4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/instance_profile/index.md @@ -0,0 +1,91 @@ +--- +title: instance_profile +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profile + - 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 +--- +Gets an individual instance_profile resource + +## Overview + + + + + +
Nameinstance_profile
TypeResource
Descriptioninstance_profile
Idawscc.dms.instance_profile
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
instance_profile_arnstringThe property describes an ARN of the instance profile.
instance_profile_identifierstringThe property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn
availability_zonestringThe property describes an availability zone of the instance profile.
descriptionstringThe optional description of the instance profile.
kms_key_arnstringThe property describes kms key arn for the instance profile.
publicly_accessiblebooleanThe property describes the publicly accessible of the instance profile
network_typestringThe property describes a network type for the instance profile.
instance_profile_namestringThe property describes a name for the instance profile.
instance_profile_creation_timestringThe property describes a creating time of the instance profile.
subnet_group_identifierstringThe property describes a subnet group identifier for the instance profile.
vpc_security_groupsarrayThe property describes vps security groups for the instance profile.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_profile resource, the following permissions are required: + +### Read +
+dms:ListInstanceProfiles,
+dms:DescribeInstanceProfiles,
+dms:ListTagsForResource
+ +### Update +
+dms:UpdateInstanceProfile,
+dms:ModifyInstanceProfile,
+dms:AddTagsToResource,
+dms:RemoveTagsToResource,
+dms:ListTagsForResource
+ +### Delete +
+dms:DeleteInstanceProfile
+ + +## Example +```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, +tags +FROM awscc.dms.instance_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceProfileArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md b/docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md new file mode 100644 index 0000000000..891526fb69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md @@ -0,0 +1,64 @@ +--- +title: instance_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles + - 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 +--- +Retrieves a list of instance_profiles in a region + +## Overview + + + + + +
Nameinstance_profiles
TypeResource
Descriptioninstance_profiles
Idawscc.dms.instance_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
instance_profile_arnstringThe property describes an ARN of the instance profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_profiles resource, the following permissions are required: + +### Create +
+dms:CreateInstanceProfile,
+dms:ListInstanceProfiles,
+dms:DescribeInstanceProfiles,
+dms:AddTagsToResource,
+dms:ListTagsForResource
+ +### List +
+dms:ListInstanceProfiles,
+dms:DescribeInstanceProfiles,
+dms:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +instance_profile_arn +FROM awscc.dms.instance_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/migration_project/index.md b/docs/awscc-docs/providers/awscc/dms/migration_project/index.md new file mode 100644 index 0000000000..373af01a36 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/migration_project/index.md @@ -0,0 +1,94 @@ +--- +title: migration_project +hide_title: false +hide_table_of_contents: false +keywords: + - migration_project + - 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 +--- +Gets an individual migration_project resource + +## Overview + + + + + +
Namemigration_project
TypeResource
Descriptionmigration_project
Idawscc.dms.migration_project
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
migration_project_namestringThe property describes a name to identify the migration project.
migration_project_identifierstringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
migration_project_arnstringThe property describes an ARN of the migration project.
migration_project_creation_timestringThe property describes a creating time of the migration project.
instance_profile_identifierstringThe property describes an instance profile identifier for the migration project. For create
instance_profile_namestringThe property describes an instance profile name for the migration project. For read
instance_profile_arnstringThe property describes an instance profile arn for the migration project. For read
transformation_rulesstringThe property describes transformation rules for the migration project.
descriptionstringThe optional description of the migration project.
schema_conversion_application_attributesobjectThe property describes schema conversion application attributes for the migration project.
source_data_provider_descriptorsarrayThe property describes source data provider descriptors for the migration project.
target_data_provider_descriptorsarrayThe property describes target data provider descriptors for the migration project.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the migration_project resource, the following permissions are required: + +### Read +
+dms:DescribeMigrationProjects,
+dms:ListMigrationProjects,
+dms:ListTagsForResource
+ +### Update +
+dms:UpdateMigrationProject,
+dms:ModifyMigrationProject,
+dms:AddTagsToResource,
+dms:RemoveTagsToResource,
+dms:ListTagsForResource,
+iam:PassRole
+ +### Delete +
+dms:DeleteMigrationProject
+ + +## Example +```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, +tags +FROM awscc.dms.migration_project +WHERE region = 'us-east-1' +AND data__Identifier = '<MigrationProjectArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/migration_projects/index.md b/docs/awscc-docs/providers/awscc/dms/migration_projects/index.md new file mode 100644 index 0000000000..723df502f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/migration_projects/index.md @@ -0,0 +1,65 @@ +--- +title: migration_projects +hide_title: false +hide_table_of_contents: false +keywords: + - migration_projects + - 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 +--- +Retrieves a list of migration_projects in a region + +## Overview + + + + + +
Namemigration_projects
TypeResource
Descriptionmigration_projects
Idawscc.dms.migration_projects
+ +## Fields + + + + + +
NameDatatypeDescription
migration_project_arnstringThe property describes an ARN of the migration project.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the migration_projects resource, the following permissions are required: + +### Create +
+dms:CreateMigrationProject,
+dms:ListMigrationProjects,
+dms:DescribeMigrationProjects,
+dms:AddTagsToResource,
+dms:ListTagsForResource,
+iam:PassRole
+ +### List +
+dms:ListMigrationProjects,
+dms:DescribeMigrationProjects,
+dms:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +migration_project_arn +FROM awscc.dms.migration_projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/replication_config/index.md b/docs/awscc-docs/providers/awscc/dms/replication_config/index.md new file mode 100644 index 0000000000..8540a951d3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/replication_config/index.md @@ -0,0 +1,95 @@ +--- +title: replication_config +hide_title: false +hide_table_of_contents: false +keywords: + - replication_config + - 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 +--- +Gets an individual replication_config resource + +## Overview + + + + + +
Namereplication_config
TypeResource
Descriptionreplication_config
Idawscc.dms.replication_config
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
replication_config_identifierstringA unique identifier of replication configuration
replication_config_arnstringThe Amazon Resource Name (ARN) of the Replication Config
source_endpoint_arnstringThe Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
target_endpoint_arnstringThe Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration
replication_typestringThe type of AWS DMS Serverless replication to provision using this replication configuration
compute_configobject
replication_settingsobjectJSON settings for Servereless replications that are provisioned using this replication configuration
supplemental_settingsobjectJSON settings for specifying supplemental data
resource_identifierstringA 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
table_mappingsobjectJSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
tagsarray<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replication_config resource, the following permissions are required: + +### Read +
+dms:DescribeReplicationConfigs,
+dms:ListTagsForResource
+ +### Update +
+dms:ModifyReplicationConfig,
+dms:AddTagsToResource,
+dms:RemoveTagsToResource,
+dms:ListTagsForResource,
+iam:CreateServiceLinkedRole,
+iam:AttachRolePolicy,
+iam:PutRolePolicy,
+iam:UpdateRoleDescription
+ +### Delete +
+dms:DescribeReplicationConfigs,
+dms:DeleteReplicationConfig,
+dms:ListTagsForResource,
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus
+ + +## Example +```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, +tags +FROM awscc.dms.replication_config +WHERE region = 'us-east-1' +AND data__Identifier = '<ReplicationConfigArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/dms/replication_configs/index.md b/docs/awscc-docs/providers/awscc/dms/replication_configs/index.md new file mode 100644 index 0000000000..055c384f73 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dms/replication_configs/index.md @@ -0,0 +1,65 @@ +--- +title: replication_configs +hide_title: false +hide_table_of_contents: false +keywords: + - replication_configs + - 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 +--- +Retrieves a list of replication_configs in a region + +## Overview + + + + + +
Namereplication_configs
TypeResource
Descriptionreplication_configs
Idawscc.dms.replication_configs
+ +## Fields + + + + + +
NameDatatypeDescription
replication_config_arnstringThe Amazon Resource Name (ARN) of the Replication Config
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replication_configs resource, the following permissions are required: + +### Create +
+dms:CreateReplicationConfig,
+dms:AddTagsToResource,
+dms:ListTagsForResource,
+iam:CreateServiceLinkedRole,
+iam:AttachRolePolicy,
+iam:PutRolePolicy,
+iam:UpdateRoleDescription
+ +### List +
+dms:DescribeReplicationConfigs,
+dms:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +replication_config_arn +FROM awscc.dms.replication_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md b/docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md new file mode 100644 index 0000000000..09d8d8d629 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md @@ -0,0 +1,116 @@ +--- +title: cluster +hide_title: false +hide_table_of_contents: false +keywords: + - cluster + - 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 +--- +Gets an individual cluster resource + +## Overview + + + + + +
Namecluster
TypeResource
Descriptioncluster
Idawscc.docdbelastic.cluster
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestring
cluster_arnstring
cluster_endpointstring
admin_user_namestring
admin_user_passwordstring
shard_capacityinteger
shard_countinteger
vpc_security_group_idsarray
subnet_idsarray
preferred_maintenance_windowstring
kms_key_idstring
tagsarray
auth_typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +
+docdb-elastic:GetCluster,
+docdb-elastic:ListTagsForResource
+ +### Update +
+docdb-elastic:UpdateCluster,
+docdb-elastic:TagResource,
+docdb-elastic:UntagResource,
+ec2:CreateVpcEndpoint,
+ec2:DescribeVpcEndpoints,
+ec2:DeleteVpcEndpoints,
+ec2:ModifyVpcEndpoint,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+ec2:DescribeAvailabilityZones,
+secretsmanager:ListSecrets,
+secretsmanager:ListSecretVersionIds,
+secretsmanager:DescribeSecret,
+secretsmanager:GetSecretValue,
+secretsmanager:GetResourcePolicy,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:GenerateDataKey,
+kms:Decrypt
+ +### Delete +
+docdb-elastic:DeleteCluster,
+ec2:DescribeVpcEndpoints,
+ec2:DeleteVpcEndpoints,
+ec2:ModifyVpcEndpoint,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+ec2:DescribeAvailabilityZones
+ + +## Example +```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, +kms_key_id, +tags, +auth_type +FROM awscc.docdbelastic.cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md b/docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md new file mode 100644 index 0000000000..50485bf78f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md @@ -0,0 +1,77 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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 +--- +Retrieves a list of clusters in a region + +## Overview + + + + + +
Nameclusters
TypeResource
Descriptionclusters
Idawscc.docdbelastic.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +
+docdb-elastic:CreateCluster,
+ec2:CreateVpcEndpoint,
+ec2:DescribeVpcEndpoints,
+ec2:DeleteVpcEndpoints,
+ec2:ModifyVpcEndpoint,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+ec2:DescribeAvailabilityZones,
+secretsmanager:ListSecrets,
+secretsmanager:ListSecretVersionIds,
+secretsmanager:DescribeSecret,
+secretsmanager:GetSecretValue,
+secretsmanager:GetResourcePolicy,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:GenerateDataKey,
+kms:Decrypt,
+iam:CreateServiceLinkedRole
+ +### List +
+docdb-elastic:ListClusters
+ + +## Example +```sql +SELECT +region, +cluster_arn +FROM awscc.docdbelastic.clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/docdbelastic/index.md b/docs/awscc-docs/providers/awscc/docdbelastic/index.md new file mode 100644 index 0000000000..e0e107a3c5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/docdbelastic/index.md @@ -0,0 +1,39 @@ +--- +title: docdbelastic +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The docdbelastic service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+cluster +
+
+clusters +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/dynamodb/global_table/index.md b/docs/awscc-docs/providers/awscc/dynamodb/global_table/index.md new file mode 100644 index 0000000000..52a34ffb4c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dynamodb/global_table/index.md @@ -0,0 +1,142 @@ +--- +title: global_table +hide_title: false +hide_table_of_contents: false +keywords: + - global_table + - 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 +--- +Gets an individual global_table resource + +## Overview + + + + + +
Nameglobal_table
TypeResource
Descriptionglobal_table
Idawscc.dynamodb.global_table
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
table_idstring
s_se_specificationobject
stream_specificationobject
replicasarray
write_provisioned_throughput_settingsobject
table_namestring
attribute_definitionsarray
billing_modestring
global_secondary_indexesarray
key_schemaarray
local_secondary_indexesarray
arnstring
stream_arnstring
time_to_live_specificationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_table resource, the following permissions are required: + +### Read +
+dynamodb:Describe*,
+dynamodb:GetResourcePolicy,
+application-autoscaling:Describe*,
+cloudwatch:PutMetricData,
+dynamodb:ListTagsOfResource,
+kms:DescribeKey
+ +### Update +
+dynamodb:Describe*,
+dynamodb:CreateTableReplica,
+dynamodb:UpdateTable,
+dynamodb:UpdateTimeToLive,
+dynamodb:UpdateContinuousBackups,
+dynamodb:UpdateContributorInsights,
+dynamodb:ListTagsOfResource,
+dynamodb:Query,
+dynamodb:Scan,
+dynamodb:UpdateItem,
+dynamodb:PutItem,
+dynamodb:GetItem,
+dynamodb:DeleteItem,
+dynamodb:BatchWriteItem,
+dynamodb:DeleteTable,
+dynamodb:DeleteTableReplica,
+dynamodb:UpdateItem,
+dynamodb:TagResource,
+dynamodb:UntagResource,
+dynamodb:EnableKinesisStreamingDestination,
+dynamodb:DisableKinesisStreamingDestination,
+dynamodb:UpdateTableReplicaAutoScaling,
+dynamodb:UpdateKinesisStreamingDestination,
+dynamodb:GetResourcePolicy,
+dynamodb:PutResourcePolicy,
+dynamodb:DeleteResourcePolicy,
+application-autoscaling:DeleteScalingPolicy,
+application-autoscaling:DeleteScheduledAction,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:Describe*,
+application-autoscaling:PutScalingPolicy,
+application-autoscaling:PutScheduledAction,
+application-autoscaling:RegisterScalableTarget,
+kinesis:ListStreams,
+kinesis:DescribeStream,
+kinesis:PutRecords,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:ListAliases,
+kms:RevokeGrant,
+cloudwatch:PutMetricData
+ +### Delete +
+dynamodb:Describe*,
+dynamodb:DeleteTable,
+application-autoscaling:DeleteScalingPolicy,
+application-autoscaling:DeleteScheduledAction,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:Describe*,
+application-autoscaling:PutScalingPolicy,
+application-autoscaling:PutScheduledAction,
+application-autoscaling:RegisterScalableTarget
+ + +## Example +```sql +SELECT +region, +table_id, +s_se_specification, +stream_specification, +replicas, +write_provisioned_throughput_settings, +table_name, +attribute_definitions, +billing_mode, +global_secondary_indexes, +key_schema, +local_secondary_indexes, +arn, +stream_arn, +time_to_live_specification +FROM awscc.dynamodb.global_table +WHERE region = 'us-east-1' +AND data__Identifier = '<TableName>' +``` diff --git a/docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md b/docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md new file mode 100644 index 0000000000..35288a36eb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md @@ -0,0 +1,96 @@ +--- +title: global_tables +hide_title: false +hide_table_of_contents: false +keywords: + - global_tables + - 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 +--- +Retrieves a list of global_tables in a region + +## Overview + + + + + +
Nameglobal_tables
TypeResource
Descriptionglobal_tables
Idawscc.dynamodb.global_tables
+ +## Fields + + + + + +
NameDatatypeDescription
table_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_tables resource, the following permissions are required: + +### Create +
+dynamodb:CreateTable,
+dynamodb:CreateTableReplica,
+dynamodb:Describe*,
+dynamodb:UpdateTimeToLive,
+dynamodb:UpdateContributorInsights,
+dynamodb:UpdateContinuousBackups,
+dynamodb:ListTagsOfResource,
+dynamodb:Query,
+dynamodb:Scan,
+dynamodb:UpdateItem,
+dynamodb:PutItem,
+dynamodb:GetItem,
+dynamodb:DeleteItem,
+dynamodb:BatchWriteItem,
+dynamodb:TagResource,
+dynamodb:EnableKinesisStreamingDestination,
+dynamodb:DisableKinesisStreamingDestination,
+dynamodb:UpdateTableReplicaAutoScaling,
+dynamodb:TagResource,
+dynamodb:GetResourcePolicy,
+dynamodb:PutResourcePolicy,
+application-autoscaling:DeleteScalingPolicy,
+application-autoscaling:DeleteScheduledAction,
+application-autoscaling:DeregisterScalableTarget,
+application-autoscaling:Describe*,
+application-autoscaling:PutScalingPolicy,
+application-autoscaling:PutScheduledAction,
+application-autoscaling:RegisterScalableTarget,
+kinesis:ListStreams,
+kinesis:DescribeStream,
+kinesis:PutRecords,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:ListAliases,
+kms:Decrypt,
+kms:RevokeGrant,
+cloudwatch:PutMetricData,
+iam:CreateServiceLinkedRole
+ +### List +
+dynamodb:ListTables,
+cloudwatch:PutMetricData
+ + +## Example +```sql +SELECT +region, +table_name +FROM awscc.dynamodb.global_tables +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/dynamodb/index.md b/docs/awscc-docs/providers/awscc/dynamodb/index.md new file mode 100644 index 0000000000..a4da9ecee1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dynamodb/index.md @@ -0,0 +1,41 @@ +--- +title: dynamodb +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The dynamodb service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+global_table
+global_tables +
+
+table
+tables +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/dynamodb/table/index.md b/docs/awscc-docs/providers/awscc/dynamodb/table/index.md new file mode 100644 index 0000000000..622efa6bb7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dynamodb/table/index.md @@ -0,0 +1,129 @@ +--- +title: table +hide_title: false +hide_table_of_contents: false +keywords: + - table + - 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 +--- +Gets an individual table resource + +## Overview + + + + + +
Nametable
TypeResource
Descriptiontable
Idawscc.dynamodb.table
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
s_se_specificationobjectSpecifies the settings to enable server-side encryption.
kinesis_stream_specificationobjectThe Kinesis Data Streams configuration for the specified table.
stream_specificationobjectThe settings for the DDB table stream, which capture changes to items stored in the table.
contributor_insights_specificationobjectThe settings used to enable or disable CloudWatch Contributor Insights for the specified table.
import_source_specificationobjectSpecifies the properties of data being imported from the S3 bucket source to the table.<br/> 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.
point_in_time_recovery_specificationobjectThe settings used to enable point in time recovery.
provisioned_throughputobjectThroughput 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). <br/> If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property.
table_namestringA 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).<br/> 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.
attribute_definitionsarrayA list of attributes that describe the key schema for the table and indexes.<br/> This property is required to create a DDB table.<br/> 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.
billing_modestringSpecify how you are charged for read and write throughput and how you manage capacity.<br/> Valid values include:<br/> + ``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).<br/> + ``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).<br/> <br/> If not specified, the default is ``PROVISIONED``.
global_secondary_indexesarrayGlobal secondary indexes to be created on the table. You can create up to 20 global secondary indexes.<br/> 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.<br/> 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. <br/> Updates are not supported. The following are exceptions:<br/> + If you update either the contributor insights specification or the provisioned throughput value
key_schemaundefinedSpecifies 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.
local_secondary_indexesarrayLocal 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.
arnstring
stream_arnstring
deletion_protection_enabledbooleanDetermines 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*.
table_classstringThe table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``.
tagsarrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
time_to_live_specificationobjectSpecifies the Time to Live (TTL) settings for the table.<br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the table resource, the following permissions are required: + +### Read +
+dynamodb:DescribeTable,
+dynamodb:DescribeContinuousBackups,
+dynamodb:DescribeContributorInsights,
+dynamodb:DescribeKinesisStreamingDestination,
+dynamodb:ListTagsOfResource,
+dynamodb:GetResourcePolicy
+ +### Update +
+dynamodb:UpdateTable,
+dynamodb:DescribeTable,
+dynamodb:DescribeTimeToLive,
+dynamodb:UpdateTimeToLive,
+dynamodb:UpdateContinuousBackups,
+dynamodb:UpdateContributorInsights,
+dynamodb:UpdateKinesisStreamingDestination,
+dynamodb:DescribeContinuousBackups,
+dynamodb:DescribeKinesisStreamingDestination,
+dynamodb:ListTagsOfResource,
+dynamodb:TagResource,
+dynamodb:UntagResource,
+dynamodb:DescribeContributorInsights,
+dynamodb:EnableKinesisStreamingDestination,
+dynamodb:DisableKinesisStreamingDestination,
+dynamodb:GetResourcePolicy,
+dynamodb:PutResourcePolicy,
+dynamodb:DeleteResourcePolicy,
+kinesis:DescribeStream,
+kinesis:PutRecords,
+iam:CreateServiceLinkedRole,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:ListAliases,
+kms:RevokeGrant
+ +### Delete +
+dynamodb:DeleteTable,
+dynamodb:DescribeTable
+ + +## Example +```sql +SELECT +region, +s_se_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, +key_schema, +local_secondary_indexes, +arn, +stream_arn, +deletion_protection_enabled, +table_class, +tags, +time_to_live_specification +FROM awscc.dynamodb.table +WHERE region = 'us-east-1' +AND data__Identifier = '<TableName>' +``` diff --git a/docs/awscc-docs/providers/awscc/dynamodb/tables/index.md b/docs/awscc-docs/providers/awscc/dynamodb/tables/index.md new file mode 100644 index 0000000000..7cd47ff6c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/dynamodb/tables/index.md @@ -0,0 +1,93 @@ +--- +title: tables +hide_title: false +hide_table_of_contents: false +keywords: + - tables + - 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 +--- +Retrieves a list of tables in a region + +## Overview + + + + + +
Nametables
TypeResource
Descriptiontables
Idawscc.dynamodb.tables
+ +## Fields + + + + + +
NameDatatypeDescription
table_namestringA 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).<br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tables resource, the following permissions are required: + +### Create +
+dynamodb:CreateTable,
+dynamodb:DescribeImport,
+dynamodb:DescribeTable,
+dynamodb:DescribeTimeToLive,
+dynamodb:UpdateTimeToLive,
+dynamodb:UpdateContributorInsights,
+dynamodb:UpdateContinuousBackups,
+dynamodb:DescribeContinuousBackups,
+dynamodb:DescribeContributorInsights,
+dynamodb:EnableKinesisStreamingDestination,
+dynamodb:DisableKinesisStreamingDestination,
+dynamodb:DescribeKinesisStreamingDestination,
+dynamodb:ImportTable,
+dynamodb:ListTagsOfResource,
+dynamodb:TagResource,
+dynamodb:UpdateTable,
+dynamodb:GetResourcePolicy,
+dynamodb:PutResourcePolicy,
+kinesis:DescribeStream,
+kinesis:PutRecords,
+iam:CreateServiceLinkedRole,
+kms:CreateGrant,
+kms:Decrypt,
+kms:DescribeKey,
+kms:ListAliases,
+kms:Encrypt,
+kms:RevokeGrant,
+logs:CreateLogGroup,
+logs:CreateLogStream,
+logs:DescribeLogGroups,
+logs:DescribeLogStreams,
+logs:PutLogEvents,
+logs:PutRetentionPolicy,
+s3:GetObject,
+s3:GetObjectMetadata,
+s3:ListBucket
+ +### List +
+dynamodb:ListTables
+ + +## Example +```sql +SELECT +region, +table_name +FROM awscc.dynamodb.tables +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/index.md b/docs/awscc-docs/providers/awscc/ecr/index.md new file mode 100644 index 0000000000..226bdf3202 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/index.md @@ -0,0 +1,47 @@ +--- +title: ecr +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ecr service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+public_repositories
+public_repository
+pull_through_cache_rule
+pull_through_cache_rules
+registry_policies +
+
+registry_policy
+replication_configuration
+replication_configurations
+repositories
+repository +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ecr/public_repositories/index.md b/docs/awscc-docs/providers/awscc/ecr/public_repositories/index.md new file mode 100644 index 0000000000..4837b84fb8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/public_repositories/index.md @@ -0,0 +1,61 @@ +--- +title: public_repositories +hide_title: false +hide_table_of_contents: false +keywords: + - public_repositories + - 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 +--- +Retrieves a list of public_repositories in a region + +## Overview + + + + + +
Namepublic_repositories
TypeResource
Descriptionpublic_repositories
Idawscc.ecr.public_repositories
+ +## Fields + + + + + +
NameDatatypeDescription
repository_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the public_repositories resource, the following permissions are required: + +### Create +
+ecr-public:CreateRepository,
+ecr-public:SetRepositoryPolicy,
+ecr-public:PutRepositoryCatalogData,
+ecr-public:TagResource
+ +### List +
+ecr-public:DescribeRepositories
+ + +## Example +```sql +SELECT +region, +repository_name +FROM awscc.ecr.public_repositories +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/public_repository/index.md b/docs/awscc-docs/providers/awscc/ecr/public_repository/index.md new file mode 100644 index 0000000000..0e7b9d22a4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/public_repository/index.md @@ -0,0 +1,78 @@ +--- +title: public_repository +hide_title: false +hide_table_of_contents: false +keywords: + - public_repository + - 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 +--- +Gets an individual public_repository resource + +## Overview + + + + + +
Namepublic_repository
TypeResource
Descriptionpublic_repository
Idawscc.ecr.public_repository
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
repository_namestringThe 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.
repository_policy_textobjectThe 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.
arnstring
repository_catalog_dataobjectThe CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link>
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the public_repository resource, the following permissions are required: + +### Read +
+ecr-public:DescribeRepositories,
+ecr-public:GetRepositoryPolicy,
+ecr-public:GetRepositoryCatalogData,
+ecr-public:ListTagsForResource
+ +### Update +
+ecr-public:SetRepositoryPolicy,
+ecr-public:DeleteRepositoryPolicy,
+ecr-public:PutRepositoryCatalogData,
+ecr-public:TagResource,
+ecr-public:UntagResource
+ +### Delete +
+ecr-public:DeleteRepository
+ + +## Example +```sql +SELECT +region, +repository_name, +repository_policy_text, +arn, +repository_catalog_data, +tags +FROM awscc.ecr.public_repository +WHERE region = 'us-east-1' +AND data__Identifier = '<RepositoryName>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rule/index.md b/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rule/index.md new file mode 100644 index 0000000000..11af3a2bd1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rule/index.md @@ -0,0 +1,74 @@ +--- +title: pull_through_cache_rule +hide_title: false +hide_table_of_contents: false +keywords: + - pull_through_cache_rule + - 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 +--- +Gets an individual pull_through_cache_rule resource + +## Overview + + + + + +
Namepull_through_cache_rule
TypeResource
Descriptionpull_through_cache_rule
Idawscc.ecr.pull_through_cache_rule
+ +## Fields + + + + + + + + +
NameDatatypeDescription
ecr_repository_prefixstringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
upstream_registry_urlstringThe upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached
credential_arnstringThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
upstream_registrystringThe name of the upstream registry.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pull_through_cache_rule resource, the following permissions are required: + +### Read +
+ecr:DescribePullThroughCacheRules
+ +### Update +
+ecr:DescribePullThroughCacheRules,
+ecr:CreatePullThroughCacheRule,
+ecr:DeletePullThroughCacheRule,
+iam:CreateServiceLinkedRole,
+secretsmanager:GetSecretValue
+ +### Delete +
+ecr:DescribePullThroughCacheRules,
+ecr:DeletePullThroughCacheRule
+ + +## Example +```sql +SELECT +region, +ecr_repository_prefix, +upstream_registry_url, +credential_arn, +upstream_registry +FROM awscc.ecr.pull_through_cache_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<EcrRepositoryPrefix>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rules/index.md b/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rules/index.md new file mode 100644 index 0000000000..bb905d7a7f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rules/index.md @@ -0,0 +1,62 @@ +--- +title: pull_through_cache_rules +hide_title: false +hide_table_of_contents: false +keywords: + - pull_through_cache_rules + - 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 +--- +Retrieves a list of pull_through_cache_rules in a region + +## Overview + + + + + +
Namepull_through_cache_rules
TypeResource
Descriptionpull_through_cache_rules
Idawscc.ecr.pull_through_cache_rules
+ +## Fields + + + + + +
NameDatatypeDescription
ecr_repository_prefixstringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pull_through_cache_rules resource, the following permissions are required: + +### Create +
+ecr:DescribePullThroughCacheRules,
+ecr:CreatePullThroughCacheRule,
+ecr:DeletePullThroughCacheRule,
+iam:CreateServiceLinkedRole,
+secretsmanager:GetSecretValue
+ +### List +
+ecr:DescribePullThroughCacheRules
+ + +## Example +```sql +SELECT +region, +ecr_repository_prefix +FROM awscc.ecr.pull_through_cache_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md b/docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md new file mode 100644 index 0000000000..35e2887412 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md @@ -0,0 +1,59 @@ +--- +title: registry_policies +hide_title: false +hide_table_of_contents: false +keywords: + - registry_policies + - 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 +--- +Retrieves a list of registry_policies in a region + +## Overview + + + + + +
Nameregistry_policies
TypeResource
Descriptionregistry_policies
Idawscc.ecr.registry_policies
+ +## Fields + + + + + +
NameDatatypeDescription
registry_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the registry_policies resource, the following permissions are required: + +### Create +
+ecr:GetRegistryPolicy,
+ecr:PutRegistryPolicy
+ +### List +
+ecr:GetRegistryPolicy
+ + +## Example +```sql +SELECT +region, +registry_id +FROM awscc.ecr.registry_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md b/docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md new file mode 100644 index 0000000000..c677f2838d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md @@ -0,0 +1,66 @@ +--- +title: registry_policy +hide_title: false +hide_table_of_contents: false +keywords: + - registry_policy + - 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 +--- +Gets an individual registry_policy resource + +## Overview + + + + + +
Nameregistry_policy
TypeResource
Descriptionregistry_policy
Idawscc.ecr.registry_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
registry_idstring
policy_textobjectThe JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the registry_policy resource, the following permissions are required: + +### Read +
+ecr:GetRegistryPolicy
+ +### Update +
+ecr:GetRegistryPolicy,
+ecr:PutRegistryPolicy
+ +### Delete +
+ecr:DeleteRegistryPolicy
+ + +## Example +```sql +SELECT +region, +registry_id, +policy_text +FROM awscc.ecr.registry_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<RegistryId>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md b/docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md new file mode 100644 index 0000000000..477cdb0df3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md @@ -0,0 +1,69 @@ +--- +title: replication_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - replication_configuration + - 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 +--- +Gets an individual replication_configuration resource + +## Overview + + + + + +
Namereplication_configuration
TypeResource
Descriptionreplication_configuration
Idawscc.ecr.replication_configuration
+ +## Fields + + + + + + +
NameDatatypeDescription
replication_configurationobject
registry_idstringThe RegistryId associated with the aws account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replication_configuration resource, the following permissions are required: + +### Read +
+ecr:DescribeRegistry
+ +### Update +
+ecr:DescribeRegistry,
+ecr:PutReplicationConfiguration,
+iam:CreateServiceLinkedRole
+ +### Delete +
+ecr:DescribeRegistry,
+ecr:PutReplicationConfiguration,
+iam:CreateServiceLinkedRole
+ + +## Example +```sql +SELECT +region, +replication_configuration, +registry_id +FROM awscc.ecr.replication_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<RegistryId>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md b/docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md new file mode 100644 index 0000000000..373a9a4c0a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: replication_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - replication_configurations + - 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 +--- +Retrieves a list of replication_configurations in a region + +## Overview + + + + + +
Namereplication_configurations
TypeResource
Descriptionreplication_configurations
Idawscc.ecr.replication_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
registry_idstringThe RegistryId associated with the aws account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replication_configurations resource, the following permissions are required: + +### Create +
+ecr:DescribeRegistry,
+ecr:PutReplicationConfiguration,
+iam:CreateServiceLinkedRole
+ +### List +
+ecr:DescribeRegistry
+ + +## Example +```sql +SELECT +region, +registry_id +FROM awscc.ecr.replication_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/repositories/index.md b/docs/awscc-docs/providers/awscc/ecr/repositories/index.md new file mode 100644 index 0000000000..6d7c88d75b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/repositories/index.md @@ -0,0 +1,64 @@ +--- +title: repositories +hide_title: false +hide_table_of_contents: false +keywords: + - repositories + - 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 +--- +Retrieves a list of repositories in a region + +## Overview + + + + + +
Namerepositories
TypeResource
Descriptionrepositories
Idawscc.ecr.repositories
+ +## Fields + + + + + +
NameDatatypeDescription
repository_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repositories resource, the following permissions are required: + +### Create +
+ecr:CreateRepository,
+ecr:PutLifecyclePolicy,
+ecr:SetRepositoryPolicy,
+ecr:TagResource,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:RetireGrant
+ +### List +
+ecr:DescribeRepositories
+ + +## Example +```sql +SELECT +region, +repository_name +FROM awscc.ecr.repositories +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecr/repository/index.md b/docs/awscc-docs/providers/awscc/ecr/repository/index.md new file mode 100644 index 0000000000..e2c6174187 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecr/repository/index.md @@ -0,0 +1,97 @@ +--- +title: repository +hide_title: false +hide_table_of_contents: false +keywords: + - repository + - 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 +--- +Gets an individual repository resource + +## Overview + + + + + +
Namerepository
TypeResource
Descriptionrepository
Idawscc.ecr.repository
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
empty_on_deleteboolean
lifecycle_policyobject
repository_namestringThe 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.
repository_policy_textobjectThe 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.
tagsarrayAn array of key-value pairs to apply to this resource.
arnstring
repository_uristring
image_tag_mutabilitystringThe image tag mutability setting for the repository.
image_scanning_configurationobject
encryption_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the repository resource, the following permissions are required: + +### Read +
+ecr:DescribeRepositories,
+ecr:GetLifecyclePolicy,
+ecr:GetRepositoryPolicy,
+ecr:ListTagsForResource
+ +### Update +
+ecr:DescribeRepositories,
+ecr:PutLifecyclePolicy,
+ecr:SetRepositoryPolicy,
+ecr:ListTagsForResource,
+ecr:TagResource,
+ecr:UntagResource,
+ecr:DeleteLifecyclePolicy,
+ecr:DeleteRepositoryPolicy,
+ecr:PutImageScanningConfiguration,
+ecr:PutImageTagMutability,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:RetireGrant
+ +### Delete +
+ecr:DeleteRepository,
+kms:RetireGrant
+ + +## Example +```sql +SELECT +region, +empty_on_delete, +lifecycle_policy, +repository_name, +repository_policy_text, +tags, +arn, +repository_uri, +image_tag_mutability, +image_scanning_configuration, +encryption_configuration +FROM awscc.ecr.repository +WHERE region = 'us-east-1' +AND data__Identifier = '<RepositoryName>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/cluster_capacity_provider_associations/index.md b/docs/awscc-docs/providers/awscc/ecs/cluster_capacity_provider_associations/index.md new file mode 100644 index 0000000000..c44f4dc89d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/cluster_capacity_provider_associations/index.md @@ -0,0 +1,69 @@ +--- +title: cluster_capacity_provider_associations +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_capacity_provider_associations + - 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 +--- +Gets an individual cluster_capacity_provider_associations resource + +## Overview + + + + + +
Namecluster_capacity_provider_associations
TypeResource
Descriptioncluster_capacity_provider_associations
Idawscc.ecs.cluster_capacity_provider_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
capacity_providersarray
clusterstring
default_capacity_provider_strategyarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster_capacity_provider_associations resource, the following permissions are required: + +### Read +
+ecs:DescribeClusters
+ +### Update +
+ecs:DescribeClusters,
+ecs:PutClusterCapacityProviders
+ +### Delete +
+ecs:PutClusterCapacityProviders,
+ecs:DescribeClusters
+ + +## Example +```sql +SELECT +region, +capacity_providers, +cluster, +default_capacity_provider_strategy +FROM awscc.ecs.cluster_capacity_provider_associations +WHERE region = 'us-east-1' +AND data__Identifier = '<Cluster>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/index.md b/docs/awscc-docs/providers/awscc/ecs/index.md new file mode 100644 index 0000000000..8dc9e89b05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/index.md @@ -0,0 +1,46 @@ +--- +title: ecs +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ecs service documentation. + +:::info Service Summary + +
+
+total resources: 9
+total selectable resources: 9
+total methods: 9
+
+
+ +::: + +## Resources +
+
+cluster_capacity_provider_associations
+primary_task_set
+primary_task_sets
+service
+services +
+
+task_definition
+task_definitions
+task_set
+task_sets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ecs/primary_task_set/index.md b/docs/awscc-docs/providers/awscc/ecs/primary_task_set/index.md new file mode 100644 index 0000000000..262a680cc4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/primary_task_set/index.md @@ -0,0 +1,69 @@ +--- +title: primary_task_set +hide_title: false +hide_table_of_contents: false +keywords: + - primary_task_set + - 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 +--- +Gets an individual primary_task_set resource + +## Overview + + + + + +
Nameprimary_task_set
TypeResource
Descriptionprimary_task_set
Idawscc.ecs.primary_task_set
+ +## Fields + + + + + + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
task_set_idstringThe ID or full Amazon Resource Name (ARN) of the task set.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the primary_task_set resource, the following permissions are required: + +### Read +
+
+ +### Update +
+ecs:DescribeTaskSets,
+ecs:UpdateServicePrimaryTaskSet
+ +### Delete +
+
+ + +## Example +```sql +SELECT +region, +cluster, +task_set_id, +service +FROM awscc.ecs.primary_task_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Cluster>' +AND data__Identifier = '<Service>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/primary_task_sets/index.md b/docs/awscc-docs/providers/awscc/ecs/primary_task_sets/index.md new file mode 100644 index 0000000000..4269e62d6f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/primary_task_sets/index.md @@ -0,0 +1,57 @@ +--- +title: primary_task_sets +hide_title: false +hide_table_of_contents: false +keywords: + - primary_task_sets + - 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 +--- +Retrieves a list of primary_task_sets in a region + +## Overview + + + + + +
Nameprimary_task_sets
TypeResource
Descriptionprimary_task_sets
Idawscc.ecs.primary_task_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the primary_task_sets resource, the following permissions are required: + +### Create +
+ecs:DescribeTaskSets,
+ecs:UpdateServicePrimaryTaskSet
+ + +## Example +```sql +SELECT +region, +cluster, +service +FROM awscc.ecs.primary_task_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/service/index.md b/docs/awscc-docs/providers/awscc/ecs/service/index.md new file mode 100644 index 0000000000..df587aed71 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/service/index.md @@ -0,0 +1,117 @@ +--- +title: service +hide_title: false +hide_table_of_contents: false +keywords: + - service + - 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 +--- +Gets an individual service resource + +## Overview + + + + + +
Nameservice
TypeResource
Descriptionservice
Idawscc.ecs.service
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
service_arnstring
capacity_provider_strategyarray
clusterstring
deployment_configurationobject
deployment_controllerobject
desired_countinteger
enable_ec_smanaged_tagsboolean
enable_execute_commandboolean
health_check_grace_period_secondsinteger
launch_typestring
load_balancersarray
namestring
network_configurationobject
placement_constraintsarray
placement_strategiesarray
platform_versionstring
propagate_tagsstring
rolestring
scheduling_strategystring
service_connect_configurationobject
service_namestring
service_registriesarray
tagsarray
task_definitionstring
volume_configurationsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +
+ecs:DescribeServices
+ +### Update +
+ecs:DescribeServices,
+ecs:ListTagsForResource,
+ecs:TagResource,
+ecs:UntagResource,
+ecs:UpdateService
+ +### Delete +
+ecs:DeleteService,
+ecs:DescribeServices
+ + +## Example +```sql +SELECT +region, +service_arn, +capacity_provider_strategy, +cluster, +deployment_configuration, +deployment_controller, +desired_count, +enable_ec_smanaged_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 awscc.ecs.service +WHERE region = 'us-east-1' +AND data__Identifier = '<ServiceArn>' +AND data__Identifier = '<Cluster>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/services/index.md b/docs/awscc-docs/providers/awscc/ecs/services/index.md new file mode 100644 index 0000000000..0ced6353be --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/services/index.md @@ -0,0 +1,65 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - 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 +--- +Retrieves a list of services in a region + +## Overview + + + + + +
Nameservices
TypeResource
Descriptionservices
Idawscc.ecs.services
+ +## Fields + + + + + + +
NameDatatypeDescription
service_arnstring
clusterstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +
+ecs:CreateService,
+ecs:DescribeServices,
+iam:PassRole,
+ecs:TagResource
+ +### List +
+ecs:DescribeServices,
+ecs:ListClusters,
+ecs:ListServices
+ + +## Example +```sql +SELECT +region, +service_arn, +cluster +FROM awscc.ecs.services +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/task_definition/index.md b/docs/awscc-docs/providers/awscc/ecs/task_definition/index.md new file mode 100644 index 0000000000..4e16412f56 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/task_definition/index.md @@ -0,0 +1,105 @@ +--- +title: task_definition +hide_title: false +hide_table_of_contents: false +keywords: + - task_definition + - 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 +--- +Gets an individual task_definition resource + +## Overview + + + + + +
Nametask_definition
TypeResource
Descriptiontask_definition
Idawscc.ecs.task_definition
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
task_definition_arnstring
familystringThe name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.<br/> 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.<br/> 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.
container_definitionsarrayA 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*.
cpustringThe 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.<br/> The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.<br/> + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)<br/> + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)<br/> + 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)<br/> + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)<br/> + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)<br/> + 8192 (8 vCPU) - Available ``memory`` va
execution_role_arnstringThe 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*.
ephemeral_storageobjectThe ephemeral storage settings to use for tasks run with the task definition.
inference_acceleratorsarrayThe Elastic Inference accelerators to use for the containers in the task.
memorystringThe amount (in MiB) of memory used by the task.<br/> 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).<br/> 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.<br/> + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)<br/> + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)<br/> + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` va
network_modestringThe 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``.<br/> 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.<br/> 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 elasti
placement_constraintsarrayAn array of placement constraint objects to use for tasks.<br/> This parameter isn't supported for tasks run on FARGATElong.
proxy_configurationobjectThe configuration details for the App Mesh proxy.<br/> 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*.
requires_compatibilitiesarrayThe 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*.
task_role_arnstringThe 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*.<br/> 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*.
volumesarrayThe 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*.<br/> The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
pid_modestringThe 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.<br/> 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.<br/> If ``task`` is specified, all containers within the specified task share the same process namespace.<br/> 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*.<br/> If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://doc
runtime_platformobjectThe operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. <br/> When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service.
ipc_modestringThe 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*.<br/> If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more inform
tagsarrayThe 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.<br/> The following basic restrictions apply to tags:<br/> + Maximum number of tags per resource - 50<br/> + For each resource, each tag key must be unique, and each tag key can have only one value.<br/> + Maximum key length - 128 Unicode characters in UTF-8<br/> + Maximum value length - 256 Unicode characters in UTF-8<br/> + 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: + - = . _ : / @.<br/> + Tag keys and values are case-sensitive.<br/> + 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
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_definition resource, the following permissions are required: + +### Read +
+ecs:DescribeTaskDefinition
+ +### Update +
+ecs:TagResource,
+ecs:UntagResource,
+ecs:ListTagsForResource,
+ecs:DescribeTaskDefinition,
+iam:GetRole,
+iam:PassRole
+ +### Delete +
+ecs:DeregisterTaskDefinition,
+ecs:DescribeTaskDefinition,
+iam:GetRole,
+iam:PassRole
+ + +## Example +```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, +tags +FROM awscc.ecs.task_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<TaskDefinitionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md b/docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md new file mode 100644 index 0000000000..76f0b472fc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md @@ -0,0 +1,63 @@ +--- +title: task_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - task_definitions + - 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 +--- +Retrieves a list of task_definitions in a region + +## Overview + + + + + +
Nametask_definitions
TypeResource
Descriptiontask_definitions
Idawscc.ecs.task_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
task_definition_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_definitions resource, the following permissions are required: + +### Create +
+ecs:RegisterTaskDefinition,
+ecs:DescribeTaskDefinition,
+ecs:TagResource,
+iam:GetRole,
+iam:PassRole
+ +### List +
+ecs:ListTaskDefinitions,
+ecs:DescribeTaskDefinition
+ + +## Example +```sql +SELECT +region, +task_definition_arn +FROM awscc.ecs.task_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/task_set/index.md b/docs/awscc-docs/providers/awscc/ecs/task_set/index.md new file mode 100644 index 0000000000..7776b1a1c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/task_set/index.md @@ -0,0 +1,91 @@ +--- +title: task_set +hide_title: false +hide_table_of_contents: false +keywords: + - task_set + - 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 +--- +Gets an individual task_set resource + +## Overview + + + + + +
Nametask_set
TypeResource
Descriptiontask_set
Idawscc.ecs.task_set
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
external_idstringAn optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
idstringThe ID of the task set.
launch_typestringThe launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
load_balancersarray
network_configurationobject
platform_versionstringThe platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
scaleobjectA floating-point percentage of the desired number of tasks to place and keep running in the task set.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
service_registriesarrayThe details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
tagsarray
task_definitionstringThe short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_set resource, the following permissions are required: + +### Read +
+ecs:DescribeTaskSets
+ +### Update +
+ecs:DescribeTaskSets,
+ecs:TagResource,
+ecs:UntagResource,
+ecs:UpdateTaskSet
+ +### Delete +
+ecs:DeleteTaskSet,
+ecs:DescribeTaskSets
+ + +## Example +```sql +SELECT +region, +cluster, +external_id, +id, +launch_type, +load_balancers, +network_configuration, +platform_version, +scale, +service, +service_registries, +tags, +task_definition +FROM awscc.ecs.task_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Cluster>' +AND data__Identifier = '<Service>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/ecs/task_sets/index.md b/docs/awscc-docs/providers/awscc/ecs/task_sets/index.md new file mode 100644 index 0000000000..fa5cf91749 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ecs/task_sets/index.md @@ -0,0 +1,60 @@ +--- +title: task_sets +hide_title: false +hide_table_of_contents: false +keywords: + - task_sets + - 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 +--- +Retrieves a list of task_sets in a region + +## Overview + + + + + +
Nametask_sets
TypeResource
Descriptiontask_sets
Idawscc.ecs.task_sets
+ +## Fields + + + + + + + +
NameDatatypeDescription
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
idstringThe ID of the task set.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_sets resource, the following permissions are required: + +### Create +
+ecs:CreateTaskSet,
+ecs:DescribeTaskSets,
+ecs:TagResource
+ + +## Example +```sql +SELECT +region, +cluster, +service, +id +FROM awscc.ecs.task_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/efs/access_point/index.md b/docs/awscc-docs/providers/awscc/efs/access_point/index.md new file mode 100644 index 0000000000..2d67076480 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/efs/access_point/index.md @@ -0,0 +1,79 @@ +--- +title: access_point +hide_title: false +hide_table_of_contents: false +keywords: + - access_point + - 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 +--- +Gets an individual access_point resource + +## Overview + + + + + +
Nameaccess_point
TypeResource
Descriptionaccess_point
Idawscc.efs.access_point
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
access_point_idstring
arnstring
client_tokenstringThe opaque string specified in the request to ensure idempotent creation.
access_point_tagsarrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
file_system_idstringThe 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``.
posix_userobjectThe 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.
root_directoryobjectThe directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +
+elasticfilesystem:DescribeAccessPoints
+ +### Delete +
+elasticfilesystem:DeleteAccessPoint,
+elasticfilesystem:DescribeAccessPoints
+ +### Update +
+elasticfilesystem:DescribeAccessPoints,
+elasticfilesystem:ListTagsForResource,
+elasticfilesystem:TagResource,
+elasticfilesystem:UntagResource
+ + +## Example +```sql +SELECT +region, +access_point_id, +arn, +client_token, +access_point_tags, +file_system_id, +posix_user, +root_directory +FROM awscc.efs.access_point +WHERE region = 'us-east-1' +AND data__Identifier = '<AccessPointId>' +``` diff --git a/docs/awscc-docs/providers/awscc/efs/access_points/index.md b/docs/awscc-docs/providers/awscc/efs/access_points/index.md new file mode 100644 index 0000000000..0fb7a3ac08 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/efs/access_points/index.md @@ -0,0 +1,60 @@ +--- +title: access_points +hide_title: false +hide_table_of_contents: false +keywords: + - access_points + - 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 +--- +Retrieves a list of access_points in a region + +## Overview + + + + + +
Nameaccess_points
TypeResource
Descriptionaccess_points
Idawscc.efs.access_points
+ +## Fields + + + + + +
NameDatatypeDescription
access_point_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +
+elasticfilesystem:CreateAccessPoint,
+elasticfilesystem:TagResource,
+elasticfilesystem:DescribeAccessPoints
+ +### List +
+elasticfilesystem:DescribeAccessPoints
+ + +## Example +```sql +SELECT +region, +access_point_id +FROM awscc.efs.access_points +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/efs/file_system/index.md b/docs/awscc-docs/providers/awscc/efs/file_system/index.md new file mode 100644 index 0000000000..fadeed323f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/efs/file_system/index.md @@ -0,0 +1,117 @@ +--- +title: file_system +hide_title: false +hide_table_of_contents: false +keywords: + - file_system + - 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 +--- +Gets an individual file_system resource + +## Overview + + + + + +
Namefile_system
TypeResource
Descriptionfile_system
Idawscc.efs.file_system
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
file_system_idstring
arnstring
encryptedbooleanA 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.
file_system_tagsarrayUse 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*.
kms_key_idstringThe 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:<br/> + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.<br/> + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.<br/> + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.<br/> + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.<br/> <br/> If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.
lifecycle_policiesarrayAn array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:<br/> + When to move files in the file system from primary storage to IA storage.<br/> + When to move files in the file system from primary storage or IA storage to Archive storage.<br/> + When to move files that are in IA or Archive storage to primary storage.<br/> <br/> 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.
file_system_protectionobjectDescribes the protection on the file system.
performance_modestringThe 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.<br/> Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.<br/> Default is ``generalPurpose``.
provisioned_throughput_in_mibpsnumberThe 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*.
throughput_modestringSpecifies 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*. <br/> Default is ``bursting``.
file_system_policyobjectThe ``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*.
bypass_policy_lockout_safety_checkboolean(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``.
backup_policyobjectUse the ``BackupPolicy`` to turn automatic backups on or off for the file system.
availability_zone_namestringFor 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*.<br/> One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
replication_configurationobjectDescribes the replication configuration for a specific file system.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the file_system resource, the following permissions are required: + +### Read +
+elasticfilesystem:DescribeBackupPolicy,
+elasticfilesystem:DescribeFileSystemPolicy,
+elasticfilesystem:DescribeFileSystems,
+elasticfilesystem:DescribeLifecycleConfiguration,
+elasticfilesystem:DescribeReplicationConfigurations
+ +### Update +
+elasticfilesystem:CreateReplicationConfiguration,
+elasticfilesystem:DeleteFileSystemPolicy,
+elasticfilesystem:DescribeBackupPolicy,
+elasticfilesystem:DescribeFileSystemPolicy,
+elasticfilesystem:DescribeFileSystems,
+elasticfilesystem:DescribeLifecycleConfiguration,
+elasticfilesystem:DescribeReplicationConfigurations,
+elasticfilesystem:DeleteTags,
+elasticfilesystem:DeleteReplicationConfiguration,
+elasticfilesystem:ListTagsForResource,
+elasticfilesystem:PutBackupPolicy,
+elasticfilesystem:PutFileSystemPolicy,
+elasticfilesystem:PutLifecycleConfiguration,
+elasticfilesystem:TagResource,
+elasticfilesystem:UntagResource,
+elasticfilesystem:UpdateFileSystem,
+elasticfilesystem:UpdateFileSystemProtection,
+kms:DescribeKey,
+kms:GenerateDataKeyWithoutPlaintext,
+kms:CreateGrant
+ +### Delete +
+elasticfilesystem:DescribeFileSystems,
+elasticfilesystem:DeleteFileSystem,
+elasticfilesystem:DeleteReplicationConfiguration,
+elasticfilesystem:DescribeReplicationConfigurations
+ + +## Example +```sql +SELECT +region, +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 awscc.efs.file_system +WHERE region = 'us-east-1' +AND data__Identifier = '<FileSystemId>' +``` diff --git a/docs/awscc-docs/providers/awscc/efs/file_systems/index.md b/docs/awscc-docs/providers/awscc/efs/file_systems/index.md new file mode 100644 index 0000000000..c1ff8bf438 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/efs/file_systems/index.md @@ -0,0 +1,73 @@ +--- +title: file_systems +hide_title: false +hide_table_of_contents: false +keywords: + - file_systems + - 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 +--- +Retrieves a list of file_systems in a region + +## Overview + + + + + +
Namefile_systems
TypeResource
Descriptionfile_systems
Idawscc.efs.file_systems
+ +## Fields + + + + + +
NameDatatypeDescription
file_system_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the file_systems resource, the following permissions are required: + +### Create +
+elasticfilesystem:CreateFileSystem,
+elasticfilesystem:DescribeReplicationConfigurations,
+elasticfilesystem:TagResource,
+elasticfilesystem:CreateReplicationConfiguration,
+elasticfilesystem:DescribeFileSystems,
+elasticfilesystem:PutBackupPolicy,
+elasticfilesystem:PutFileSystemPolicy,
+elasticfilesystem:PutLifecycleConfiguration,
+elasticfilesystem:UpdateFileSystemProtection,
+kms:DescribeKey,
+kms:GenerateDataKeyWithoutPlaintext,
+kms:CreateGrant
+ +### List +
+elasticfilesystem:DescribeBackupPolicy,
+elasticfilesystem:DescribeFileSystemPolicy,
+elasticfilesystem:DescribeFileSystems,
+elasticfilesystem:DescribeLifecycleConfiguration,
+elasticfilesystem:DescribeReplicationConfigurations
+ + +## Example +```sql +SELECT +region, +file_system_id +FROM awscc.efs.file_systems +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/efs/index.md b/docs/awscc-docs/providers/awscc/efs/index.md new file mode 100644 index 0000000000..d8d3e2ff4f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/efs/index.md @@ -0,0 +1,43 @@ +--- +title: efs +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The efs service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+access_point
+access_points
+file_system +
+
+file_systems
+mount_target
+mount_targets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/efs/mount_target/index.md b/docs/awscc-docs/providers/awscc/efs/mount_target/index.md new file mode 100644 index 0000000000..5d1fe9f521 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/efs/mount_target/index.md @@ -0,0 +1,75 @@ +--- +title: mount_target +hide_title: false +hide_table_of_contents: false +keywords: + - mount_target + - 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 +--- +Gets an individual mount_target resource + +## Overview + + + + + +
Namemount_target
TypeResource
Descriptionmount_target
Idawscc.efs.mount_target
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstring
ip_addressstringValid IPv4 address within the address range of the specified subnet.
file_system_idstringThe ID of the file system for which to create the mount target.
security_groupsarrayUp to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified.
subnet_idstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the mount_target resource, the following permissions are required: + +### Read +
+elasticfilesystem:DescribeMountTargets,
+elasticfilesystem:DescribeMountTargetSecurityGroups
+ +### Update +
+elasticfilesystem:DescribeMountTargets,
+elasticfilesystem:DescribeMountTargetSecurityGroups,
+elasticfilesystem:ModifyMountTargetSecurityGroups
+ +### Delete +
+elasticfilesystem:DescribeMountTargets,
+elasticfilesystem:DeleteMountTarget
+ + +## Example +```sql +SELECT +region, +id, +ip_address, +file_system_id, +security_groups, +subnet_id +FROM awscc.efs.mount_target +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/efs/mount_targets/index.md b/docs/awscc-docs/providers/awscc/efs/mount_targets/index.md new file mode 100644 index 0000000000..4f35fc0f45 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/efs/mount_targets/index.md @@ -0,0 +1,60 @@ +--- +title: mount_targets +hide_title: false +hide_table_of_contents: false +keywords: + - mount_targets + - 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 +--- +Retrieves a list of mount_targets in a region + +## Overview + + + + + +
Namemount_targets
TypeResource
Descriptionmount_targets
Idawscc.efs.mount_targets
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the mount_targets resource, the following permissions are required: + +### Create +
+elasticfilesystem:CreateMountTarget,
+elasticfilesystem:DescribeMountTargets
+ +### List +
+elasticfilesystem:DescribeMountTargets,
+elasticfilesystem:DescribeMountTargetSecurityGroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.efs.mount_targets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/access_entries/index.md b/docs/awscc-docs/providers/awscc/eks/access_entries/index.md new file mode 100644 index 0000000000..3f070d6a28 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/access_entries/index.md @@ -0,0 +1,64 @@ +--- +title: access_entries +hide_title: false +hide_table_of_contents: false +keywords: + - access_entries + - 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 +--- +Retrieves a list of access_entries in a region + +## Overview + + + + + +
Nameaccess_entries
TypeResource
Descriptionaccess_entries
Idawscc.eks.access_entries
+ +## Fields + + + + + + +
NameDatatypeDescription
principal_arnstringThe principal ARN that the access entry is created for.
cluster_namestringThe cluster that the access entry is created for.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_entries resource, the following permissions are required: + +### Create +
+eks:CreateAccessEntry,
+eks:DescribeAccessEntry,
+eks:AssociateAccessPolicy,
+eks:TagResource,
+eks:ListAssociatedAccessPolicies
+ +### List +
+eks:ListAccessEntries
+ + +## Example +```sql +SELECT +region, +principal_arn, +cluster_name +FROM awscc.eks.access_entries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/access_entry/index.md b/docs/awscc-docs/providers/awscc/eks/access_entry/index.md new file mode 100644 index 0000000000..1a9a2c1b02 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/access_entry/index.md @@ -0,0 +1,86 @@ +--- +title: access_entry +hide_title: false +hide_table_of_contents: false +keywords: + - access_entry + - 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 +--- +Gets an individual access_entry resource + +## Overview + + + + + +
Nameaccess_entry
TypeResource
Descriptionaccess_entry
Idawscc.eks.access_entry
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestringThe cluster that the access entry is created for.
principal_arnstringThe principal ARN that the access entry is created for.
usernamestringThe Kubernetes user that the access entry is associated with.
tagsarrayAn array of key-value pairs to apply to this resource.
access_entry_arnstringThe ARN of the access entry.
kubernetes_groupsarrayThe Kubernetes groups that the access entry is associated with.
access_policiesarrayAn array of access policies that are associated with the access entry.
typestringThe node type to associate with the access entry.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_entry resource, the following permissions are required: + +### Read +
+eks:DescribeAccessEntry,
+eks:ListAssociatedAccessPolicies
+ +### Update +
+eks:DescribeAccessEntry,
+eks:ListAssociatedAccessPolicies,
+eks:UpdateAccessEntry,
+eks:AssociateAccessPolicy,
+eks:DisassociateAccessPolicy,
+eks:TagResource,
+eks:UntagResource
+ +### Delete +
+eks:DeleteAccessEntry,
+eks:DescribeAccessEntry
+ + +## Example +```sql +SELECT +region, +cluster_name, +principal_arn, +username, +tags, +access_entry_arn, +kubernetes_groups, +access_policies, +type +FROM awscc.eks.access_entry +WHERE region = 'us-east-1' +AND data__Identifier = '<PrincipalArn>' +AND data__Identifier = '<ClusterName>' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/addon/index.md b/docs/awscc-docs/providers/awscc/eks/addon/index.md new file mode 100644 index 0000000000..4484c45bd2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/addon/index.md @@ -0,0 +1,87 @@ +--- +title: addon +hide_title: false +hide_table_of_contents: false +keywords: + - addon + - 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 +--- +Gets an individual addon resource + +## Overview + + + + + +
Nameaddon
TypeResource
Descriptionaddon
Idawscc.eks.addon
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestringName of Cluster
addon_namestringName of Addon
addon_versionstringVersion of Addon
preserve_on_deletebooleanPreserveOnDelete parameter value
resolve_conflictsstringResolve parameter value conflicts
service_account_role_arnstringIAM role to bind to the add-on's service account
configuration_valuesstringThe configuration values to use with the add-on
arnstringAmazon Resource Name (ARN) of the add-on
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the addon resource, the following permissions are required: + +### Read +
+eks:DescribeAddon
+ +### Delete +
+eks:DeleteAddon,
+eks:DescribeAddon
+ +### Update +
+iam:PassRole,
+eks:UpdateAddon,
+eks:DescribeAddon,
+eks:DescribeUpdate,
+eks:ListTagsForResource,
+eks:TagResource,
+eks:UntagResource
+ + +## Example +```sql +SELECT +region, +cluster_name, +addon_name, +addon_version, +preserve_on_delete, +resolve_conflicts, +service_account_role_arn, +configuration_values, +arn, +tags +FROM awscc.eks.addon +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterName>' +AND data__Identifier = '<AddonName>' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/addons/index.md b/docs/awscc-docs/providers/awscc/eks/addons/index.md new file mode 100644 index 0000000000..c680964429 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/addons/index.md @@ -0,0 +1,63 @@ +--- +title: addons +hide_title: false +hide_table_of_contents: false +keywords: + - addons + - 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 +--- +Retrieves a list of addons in a region + +## Overview + + + + + +
Nameaddons
TypeResource
Descriptionaddons
Idawscc.eks.addons
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_namestringName of Cluster
addon_namestringName of Addon
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the addons resource, the following permissions are required: + +### Create +
+eks:CreateAddon,
+eks:DescribeAddon,
+eks:TagResource,
+iam:PassRole
+ +### List +
+eks:ListAddons
+ + +## Example +```sql +SELECT +region, +cluster_name, +addon_name +FROM awscc.eks.addons +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/cluster/index.md b/docs/awscc-docs/providers/awscc/eks/cluster/index.md new file mode 100644 index 0000000000..c8eeffb555 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/cluster/index.md @@ -0,0 +1,102 @@ +--- +title: cluster +hide_title: false +hide_table_of_contents: false +keywords: + - cluster + - 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 +--- +Gets an individual cluster resource + +## Overview + + + + + +
Namecluster
TypeResource
Descriptioncluster
Idawscc.eks.cluster
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
encryption_configarray
kubernetes_network_configobject
loggingobject
namestringThe unique name to give to your cluster.
idstringThe unique ID given to your cluster.
resources_vpc_configobject
outpost_configobject
access_configobject
role_arnstringThe 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.
versionstringThe desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
tagsarrayAn array of key-value pairs to apply to this resource.
arnstringThe ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
endpointstringThe endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
certificate_authority_datastringThe certificate-authority-data for your cluster.
cluster_security_group_idstringThe 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.
encryption_config_key_arnstringAmazon Resource Name (ARN) or alias of the customer master key (CMK).
open_id_connect_issuer_urlstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +
+eks:DescribeCluster
+ +### Update +
+iam:PassRole,
+eks:UpdateClusterConfig,
+eks:UpdateClusterVersion,
+eks:DescribeCluster,
+eks:DescribeUpdate,
+eks:TagResource,
+eks:UntagResource
+ +### Delete +
+eks:DeleteCluster,
+eks:DescribeCluster
+ + +## Example +```sql +SELECT +region, +encryption_config, +kubernetes_network_config, +logging, +name, +id, +resources_vpc_config, +outpost_config, +access_config, +role_arn, +version, +tags, +arn, +endpoint, +certificate_authority_data, +cluster_security_group_id, +encryption_config_key_arn, +open_id_connect_issuer_url +FROM awscc.eks.cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/clusters/index.md b/docs/awscc-docs/providers/awscc/eks/clusters/index.md new file mode 100644 index 0000000000..01382210c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/clusters/index.md @@ -0,0 +1,74 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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 +--- +Retrieves a list of clusters in a region + +## Overview + + + + + +
Nameclusters
TypeResource
Descriptionclusters
Idawscc.eks.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe unique name to give to your cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +
+eks:CreateCluster,
+eks:DescribeCluster,
+eks:TagResource,
+iam:PassRole,
+iam:GetRole,
+iam:ListAttachedRolePolicies,
+iam:CreateServiceLinkedRole,
+iam:CreateInstanceProfile,
+iam:TagInstanceProfile,
+iam:AddRoleToInstanceProfile,
+iam:GetInstanceProfile,
+iam:DeleteInstanceProfile,
+iam:RemoveRoleFromInstanceProfile,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+kms:DescribeKey,
+kms:CreateGrant
+ +### List +
+eks:ListClusters
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.eks.clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md b/docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md new file mode 100644 index 0000000000..7305517e62 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md @@ -0,0 +1,80 @@ +--- +title: fargate_profile +hide_title: false +hide_table_of_contents: false +keywords: + - fargate_profile + - 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 +--- +Gets an individual fargate_profile resource + +## Overview + + + + + +
Namefargate_profile
TypeResource
Descriptionfargate_profile
Idawscc.eks.fargate_profile
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestringName of the Cluster
fargate_profile_namestringName of FargateProfile
pod_execution_role_arnstringThe IAM policy arn for pods
arnstring
subnetsarray
selectorsarray
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fargate_profile resource, the following permissions are required: + +### Read +
+eks:DescribeFargateProfile
+ +### Delete +
+eks:DeleteFargateProfile,
+eks:DescribeFargateProfile
+ +### Update +
+eks:DescribeFargateProfile,
+eks:ListTagsForResource,
+eks:TagResource,
+eks:UntagResource
+ + +## Example +```sql +SELECT +region, +cluster_name, +fargate_profile_name, +pod_execution_role_arn, +arn, +subnets, +selectors, +tags +FROM awscc.eks.fargate_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterName>' +AND data__Identifier = '<FargateProfileName>' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md b/docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md new file mode 100644 index 0000000000..ef60ace379 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md @@ -0,0 +1,65 @@ +--- +title: fargate_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - fargate_profiles + - 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 +--- +Retrieves a list of fargate_profiles in a region + +## Overview + + + + + +
Namefargate_profiles
TypeResource
Descriptionfargate_profiles
Idawscc.eks.fargate_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_namestringName of the Cluster
fargate_profile_namestringName of FargateProfile
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fargate_profiles resource, the following permissions are required: + +### Create +
+eks:CreateFargateProfile,
+eks:DescribeFargateProfile,
+iam:GetRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+eks:TagResource
+ +### List +
+eks:ListFargateProfiles
+ + +## Example +```sql +SELECT +region, +cluster_name, +fargate_profile_name +FROM awscc.eks.fargate_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/identity_provider_config/index.md b/docs/awscc-docs/providers/awscc/eks/identity_provider_config/index.md new file mode 100644 index 0000000000..a4582e06fb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/identity_provider_config/index.md @@ -0,0 +1,78 @@ +--- +title: identity_provider_config +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider_config + - 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 +--- +Gets an individual identity_provider_config resource + +## Overview + + + + + +
Nameidentity_provider_config
TypeResource
Descriptionidentity_provider_config
Idawscc.eks.identity_provider_config
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
cluster_namestringThe name of the identity provider configuration.
typestringThe type of the identity provider configuration.
identity_provider_config_namestringThe name of the OIDC provider configuration.
oidcobject
tagsarrayAn array of key-value pairs to apply to this resource.
identity_provider_config_arnstringThe ARN of the configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_provider_config resource, the following permissions are required: + +### Read +
+eks:DescribeIdentityProviderConfig
+ +### Update +
+eks:DescribeIdentityProviderConfig,
+eks:TagResource,
+eks:UntagResource
+ +### Delete +
+eks:DisassociateIdentityProviderConfig,
+eks:DescribeIdentityProviderConfig
+ + +## Example +```sql +SELECT +region, +cluster_name, +type, +identity_provider_config_name, +oidc, +tags, +identity_provider_config_arn +FROM awscc.eks.identity_provider_config +WHERE region = 'us-east-1' +AND data__Identifier = '<IdentityProviderConfigName>' +AND data__Identifier = '<ClusterName>' +AND data__Identifier = '<Type>' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/identity_provider_configs/index.md b/docs/awscc-docs/providers/awscc/eks/identity_provider_configs/index.md new file mode 100644 index 0000000000..c9345d15e0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/identity_provider_configs/index.md @@ -0,0 +1,65 @@ +--- +title: identity_provider_configs +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider_configs + - 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 +--- +Retrieves a list of identity_provider_configs in a region + +## Overview + + + + + +
Nameidentity_provider_configs
TypeResource
Descriptionidentity_provider_configs
Idawscc.eks.identity_provider_configs
+ +## Fields + + + + + + + +
NameDatatypeDescription
identity_provider_config_namestringThe name of the OIDC provider configuration.
cluster_namestringThe name of the identity provider configuration.
typestringThe type of the identity provider configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_provider_configs resource, the following permissions are required: + +### Create +
+eks:DescribeUpdate,
+eks:AssociateIdentityProviderConfig,
+eks:DescribeIdentityProviderConfig,
+eks:TagResource
+ +### List +
+eks:ListIdentityProviderConfigs
+ + +## Example +```sql +SELECT +region, +identity_provider_config_name, +cluster_name, +type +FROM awscc.eks.identity_provider_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/index.md b/docs/awscc-docs/providers/awscc/eks/index.md new file mode 100644 index 0000000000..9e37fcf273 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/index.md @@ -0,0 +1,51 @@ +--- +title: eks +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The eks service documentation. + +:::info Service Summary + +
+
+total resources: 14
+total selectable resources: 14
+total methods: 14
+
+
+ +::: + +## Resources +
+
+access_entries
+access_entry
+addon
+addons
+cluster
+clusters
+fargate_profile +
+
+fargate_profiles
+identity_provider_config
+identity_provider_configs
+nodegroup
+nodegroups
+pod_identity_association
+pod_identity_associations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/eks/nodegroup/index.md b/docs/awscc-docs/providers/awscc/eks/nodegroup/index.md new file mode 100644 index 0000000000..1fc542ec89 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/nodegroup/index.md @@ -0,0 +1,110 @@ +--- +title: nodegroup +hide_title: false +hide_table_of_contents: false +keywords: + - nodegroup + - 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 +--- +Gets an individual nodegroup resource + +## Overview + + + + + +
Namenodegroup
TypeResource
Descriptionnodegroup
Idawscc.eks.nodegroup
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ami_typestringThe AMI type for your node group.
capacity_typestringThe capacity type of your managed node group.
cluster_namestringName of the cluster to create the node group in.
disk_sizeintegerThe root device disk size (in GiB) for your node group instances.
force_update_enabledbooleanForce the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
instance_typesarraySpecify the instance types for a node group.
labelsobjectThe Kubernetes labels to be applied to the nodes in the node group when they are created.
launch_templateobjectAn object representing a node group's launch template specification.
nodegroup_namestringThe unique name to give your node group.
node_rolestringThe Amazon Resource Name (ARN) of the IAM role to associate with your node group.
release_versionstringThe AMI version of the Amazon EKS-optimized AMI to use with your node group.
remote_accessobjectThe remote access (SSH) configuration to use with your node group.
scaling_configobjectThe scaling configuration details for the Auto Scaling group that is created for your node group.
subnetsarrayThe subnets to use for the Auto Scaling group that is created for your node group.
tagsobjectThe metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
taintsarrayThe Kubernetes taints to be applied to the nodes in the node group when they are created.
update_configobjectThe node group update configuration.
versionstringThe Kubernetes version to use for your managed nodes.
idstring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the nodegroup resource, the following permissions are required: + +### Read +
+eks:DescribeNodegroup
+ +### Delete +
+eks:DeleteNodegroup,
+eks:DescribeNodegroup
+ +### Update +
+iam:GetRole,
+iam:PassRole,
+eks:DescribeNodegroup,
+eks:DescribeUpdate,
+eks:ListUpdates,
+eks:TagResource,
+eks:UntagResource,
+eks:UpdateNodegroupConfig,
+eks:UpdateNodegroupVersion
+ + +## Example +```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, +tags, +taints, +update_config, +version, +id, +arn +FROM awscc.eks.nodegroup +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/nodegroups/index.md b/docs/awscc-docs/providers/awscc/eks/nodegroups/index.md new file mode 100644 index 0000000000..fab2d36df8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/nodegroups/index.md @@ -0,0 +1,74 @@ +--- +title: nodegroups +hide_title: false +hide_table_of_contents: false +keywords: + - nodegroups + - 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 +--- +Retrieves a list of nodegroups in a region + +## Overview + + + + + +
Namenodegroups
TypeResource
Descriptionnodegroups
Idawscc.eks.nodegroups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the nodegroups resource, the following permissions are required: + +### Create +
+eks:CreateNodegroup,
+eks:DescribeNodegroup,
+eks:TagResource,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+ec2:DescribeSecurityGroups,
+ec2:DescribeKeyPairs,
+ec2:CreateTags,
+ec2:DeleteTags,
+ec2:DescribeRouteTables,
+ec2:DescribeLaunchTemplates,
+ec2:DescribeLaunchTemplateVersions,
+ec2:RunInstances,
+iam:CreateServiceLinkedRole,
+iam:GetRole,
+iam:PassRole,
+iam:ListAttachedRolePolicies
+ +### List +
+eks:ListNodegroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.eks.nodegroups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/pod_identity_association/index.md b/docs/awscc-docs/providers/awscc/eks/pod_identity_association/index.md new file mode 100644 index 0000000000..de08c53816 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/pod_identity_association/index.md @@ -0,0 +1,81 @@ +--- +title: pod_identity_association +hide_title: false +hide_table_of_contents: false +keywords: + - pod_identity_association + - 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 +--- +Gets an individual pod_identity_association resource + +## Overview + + + + + +
Namepod_identity_association
TypeResource
Descriptionpod_identity_association
Idawscc.eks.pod_identity_association
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestringThe cluster that the pod identity association is created for.
role_arnstringThe IAM role ARN that the pod identity association is created for.
namespacestringThe Kubernetes namespace that the pod identity association is created for.
service_accountstringThe Kubernetes service account that the pod identity association is created for.
association_arnstringThe ARN of the pod identity association.
association_idstringThe ID of the pod identity association.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pod_identity_association resource, the following permissions are required: + +### Read +
+eks:DescribePodIdentityAssociation
+ +### Update +
+eks:DescribePodIdentityAssociation,
+eks:UpdatePodIdentityAssociation,
+eks:TagResource,
+eks:UntagResource,
+iam:PassRole,
+iam:GetRole
+ +### Delete +
+eks:DeletePodIdentityAssociation,
+eks:DescribePodIdentityAssociation
+ + +## Example +```sql +SELECT +region, +cluster_name, +role_arn, +namespace, +service_account, +association_arn, +association_id, +tags +FROM awscc.eks.pod_identity_association +WHERE region = 'us-east-1' +AND data__Identifier = '<AssociationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/eks/pod_identity_associations/index.md b/docs/awscc-docs/providers/awscc/eks/pod_identity_associations/index.md new file mode 100644 index 0000000000..113cf574e6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eks/pod_identity_associations/index.md @@ -0,0 +1,62 @@ +--- +title: pod_identity_associations +hide_title: false +hide_table_of_contents: false +keywords: + - pod_identity_associations + - 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 +--- +Retrieves a list of pod_identity_associations in a region + +## Overview + + + + + +
Namepod_identity_associations
TypeResource
Descriptionpod_identity_associations
Idawscc.eks.pod_identity_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_arnstringThe ARN of the pod identity association.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pod_identity_associations resource, the following permissions are required: + +### Create +
+eks:CreatePodIdentityAssociation,
+eks:DescribePodIdentityAssociation,
+eks:TagResource,
+iam:PassRole,
+iam:GetRole
+ +### List +
+eks:ListPodIdentityAssociations
+ + +## Example +```sql +SELECT +region, +association_arn +FROM awscc.eks.pod_identity_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/global_replication_group/index.md b/docs/awscc-docs/providers/awscc/elasticache/global_replication_group/index.md new file mode 100644 index 0000000000..250ad7d8c5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/global_replication_group/index.md @@ -0,0 +1,91 @@ +--- +title: global_replication_group +hide_title: false +hide_table_of_contents: false +keywords: + - global_replication_group + - 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 +--- +Gets an individual global_replication_group resource + +## Overview + + + + + +
Nameglobal_replication_group
TypeResource
Descriptionglobal_replication_group
Idawscc.elasticache.global_replication_group
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
global_replication_group_id_suffixstringThe 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.
automatic_failover_enabledbooleanAutomaticFailoverEnabled
cache_node_typestringThe cache node type of the Global Datastore
engine_versionstringThe engine version of the Global Datastore.
cache_parameter_group_namestringCache parameter group name to use for the new engine version. This parameter cannot be modified independently.
global_node_group_countintegerIndicates the number of node groups in the Global Datastore.
global_replication_group_descriptionstringThe optional description of the Global Datastore
global_replication_group_idstringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
membersarrayThe replication groups that comprise the Global Datastore.
statusstringThe status of the Global Datastore
regional_configurationsarrayDescribes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_replication_group resource, the following permissions are required: + +### Read +
+elasticache:DescribeGlobalReplicationGroups
+ +### Update +
+elasticache:ModifyGlobalReplicationGroup,
+elasticache:FailoverGlobalReplicationGroup,
+elasticache:DescribeGlobalReplicationGroups,
+elasticache:IncreaseNodeGroupsInGlobalReplicationGroup,
+elasticache:DecreaseNodeGroupsInGlobalReplicationGroup,
+elasticache:DisassociateGlobalReplicationGroup,
+elasticache:RebalanceSlotsInGlobalReplicationGroup
+ +### Delete +
+elasticache:DeleteGlobalReplicationGroup,
+elasticache:DisassociateGlobalReplicationGroup,
+elasticache:DescribeGlobalReplicationGroups
+ + +## Example +```sql +SELECT +region, +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 awscc.elasticache.global_replication_group +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalReplicationGroupId>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/global_replication_groups/index.md b/docs/awscc-docs/providers/awscc/elasticache/global_replication_groups/index.md new file mode 100644 index 0000000000..7eed51e2bb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/global_replication_groups/index.md @@ -0,0 +1,59 @@ +--- +title: global_replication_groups +hide_title: false +hide_table_of_contents: false +keywords: + - global_replication_groups + - 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 +--- +Retrieves a list of global_replication_groups in a region + +## Overview + + + + + +
Nameglobal_replication_groups
TypeResource
Descriptionglobal_replication_groups
Idawscc.elasticache.global_replication_groups
+ +## Fields + + + + + +
NameDatatypeDescription
global_replication_group_idstringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_replication_groups resource, the following permissions are required: + +### Create +
+elasticache:CreateGlobalReplicationGroup,
+elasticache:DescribeGlobalReplicationGroups
+ +### List +
+elasticache:DescribeGlobalReplicationGroups
+ + +## Example +```sql +SELECT +region, +global_replication_group_id +FROM awscc.elasticache.global_replication_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/index.md b/docs/awscc-docs/providers/awscc/elasticache/index.md new file mode 100644 index 0000000000..60382eca44 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/index.md @@ -0,0 +1,47 @@ +--- +title: elasticache +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The elasticache service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+global_replication_group
+global_replication_groups
+serverless_cache
+serverless_caches
+subnet_group +
+
+subnet_groups
+user
+user_group
+user_groups
+users +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/elasticache/serverless_cache/index.md b/docs/awscc-docs/providers/awscc/elasticache/serverless_cache/index.md new file mode 100644 index 0000000000..426ddb9844 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/serverless_cache/index.md @@ -0,0 +1,108 @@ +--- +title: serverless_cache +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_cache + - 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 +--- +Gets an individual serverless_cache resource + +## Overview + + + + + +
Nameserverless_cache
TypeResource
Descriptionserverless_cache
Idawscc.elasticache.serverless_cache
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
serverless_cache_namestringThe name of the Serverless Cache. This value must be unique.
descriptionstringThe description of the Serverless Cache.
enginestringThe engine name of the Serverless Cache.
major_engine_versionstringThe major engine version of the Serverless Cache.
full_engine_versionstringThe full engine version of the Serverless Cache.
cache_usage_limitsobject
kms_key_idstringThe ID of the KMS key used to encrypt the cluster.
security_group_idsarrayOne or more Amazon VPC security groups associated with this Serverless Cache.
snapshot_arns_to_restorearrayThe ARN's of snapshot to restore Serverless Cache.
tagsarrayAn array of key-value pairs to apply to this Serverless Cache.
user_group_idstringThe ID of the user group.
subnet_idsarrayThe subnet id's of the Serverless Cache.
snapshot_retention_limitintegerThe snapshot retention limit of the Serverless Cache.
daily_snapshot_timestringThe daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
create_timestringThe creation time of the Serverless Cache.
statusstringThe status of the Serverless Cache.
endpointobject
reader_endpointobject
a_rnstringThe ARN of the Serverless Cache.
final_snapshot_namestringThe final snapshot name which is taken before Serverless Cache is deleted.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the serverless_cache resource, the following permissions are required: + +### Read +
+elasticache:DescribeServerlessCaches,
+elasticache:ListTagsForResource
+ +### Update +
+elasticache:ModifyServerlessCache,
+elasticache:DescribeServerlessCaches,
+elasticache:AddTagsToResource,
+elasticache:ListTagsForResource,
+elasticache:RemoveTagsFromResource
+ +### Delete +
+elasticache:DeleteServerlessCache,
+elasticache:DescribeServerlessCaches,
+elasticache:ListTagsForResource
+ + +## Example +```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, +tags, +user_group_id, +subnet_ids, +snapshot_retention_limit, +daily_snapshot_time, +create_time, +status, +endpoint, +reader_endpoint, +a_rn, +final_snapshot_name +FROM awscc.elasticache.serverless_cache +WHERE region = 'us-east-1' +AND data__Identifier = '<ServerlessCacheName>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md b/docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md new file mode 100644 index 0000000000..46f43ad074 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md @@ -0,0 +1,66 @@ +--- +title: serverless_caches +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_caches + - 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 +--- +Retrieves a list of serverless_caches in a region + +## Overview + + + + + +
Nameserverless_caches
TypeResource
Descriptionserverless_caches
Idawscc.elasticache.serverless_caches
+ +## Fields + + + + + +
NameDatatypeDescription
serverless_cache_namestringThe name of the Serverless Cache. This value must be unique.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the serverless_caches resource, the following permissions are required: + +### Create +
+elasticache:CreateServerlessCache,
+elasticache:DescribeServerlessCaches,
+elasticache:AddTagsToResource,
+elasticache:ListTagsForResource,
+ec2:CreateTags,
+ec2:CreateVpcEndpoint,
+kms:CreateGrant,
+kms:DescribeKey
+ +### List +
+elasticache:DescribeServerlessCaches,
+elasticache:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +serverless_cache_name +FROM awscc.elasticache.serverless_caches +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md b/docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md new file mode 100644 index 0000000000..5c43f916a7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md @@ -0,0 +1,75 @@ +--- +title: subnet_group +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_group + - 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 +--- +Gets an individual subnet_group resource + +## Overview + + + + + +
Namesubnet_group
TypeResource
Descriptionsubnet_group
Idawscc.elasticache.subnet_group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description for the cache subnet group.
subnet_idsarrayThe EC2 subnet IDs for the cache subnet group.
cache_subnet_group_namestringThe name for the cache subnet group. This value is stored as a lowercase string.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subnet_group resource, the following permissions are required: + +### Read +
+elasticache:DescribeCacheSubnetGroups,
+elasticache:ListTagsForResource
+ +### Delete +
+elasticache:DeleteCacheSubnetGroup,
+elasticache:DescribeCacheSubnetGroups,
+elasticache:ListTagsForResource
+ +### Update +
+elasticache:ModifyCacheSubnetGroup,
+elasticache:DescribeCacheSubnetGroups,
+elasticache:AddTagsToResource,
+elasticache:RemoveTagsFromResource
+ + +## Example +```sql +SELECT +region, +description, +subnet_ids, +cache_subnet_group_name, +tags +FROM awscc.elasticache.subnet_group +WHERE region = 'us-east-1' +AND data__Identifier = '<CacheSubnetGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md b/docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md new file mode 100644 index 0000000000..3e10bde4ff --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md @@ -0,0 +1,61 @@ +--- +title: subnet_groups +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_groups + - 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 +--- +Retrieves a list of subnet_groups in a region + +## Overview + + + + + +
Namesubnet_groups
TypeResource
Descriptionsubnet_groups
Idawscc.elasticache.subnet_groups
+ +## Fields + + + + + +
NameDatatypeDescription
cache_subnet_group_namestringThe name for the cache subnet group. This value is stored as a lowercase string.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subnet_groups resource, the following permissions are required: + +### Create +
+elasticache:CreateCacheSubnetGroup,
+elasticache:AddTagsToResource,
+elasticache:DescribeCacheSubnetGroups,
+elasticache:ListTagsForResource
+ +### List +
+elasticache:DescribeCacheSubnetGroups
+ + +## Example +```sql +SELECT +region, +cache_subnet_group_name +FROM awscc.elasticache.subnet_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/user/index.md b/docs/awscc-docs/providers/awscc/elasticache/user/index.md new file mode 100644 index 0000000000..be9efb9b98 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/user/index.md @@ -0,0 +1,87 @@ +--- +title: user +hide_title: false +hide_table_of_contents: false +keywords: + - user + - 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 +--- +Gets an individual user resource + +## Overview + + + + + +
Nameuser
TypeResource
Descriptionuser
Idawscc.elasticache.user
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
statusstringIndicates the user status. Can be "active", "modifying" or "deleting".
user_idstringThe ID of the user.
user_namestringThe username of the user.
enginestringMust be redis.
access_stringstringAccess permissions string used for this user account.
no_password_requiredbooleanIndicates a password is not required for this user account.
passwordsarrayPasswords used for this user account. You can create up to two passwords for each user.
arnstringThe Amazon Resource Name (ARN) of the user account.
authentication_modeobject
tagsarrayAn array of key-value pairs to apply to this user.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +
+elasticache:DescribeUsers,
+elasticache:ListTagsForResource
+ +### Update +
+elasticache:ModifyUser,
+elasticache:DescribeUsers,
+elasticache:ListTagsForResource,
+elasticache:AddTagsToResource,
+elasticache:RemoveTagsFromResource
+ +### Delete +
+elasticache:DeleteUser,
+elasticache:DescribeUsers
+ + +## Example +```sql +SELECT +region, +status, +user_id, +user_name, +engine, +access_string, +no_password_required, +passwords, +arn, +authentication_mode, +tags +FROM awscc.elasticache.user +WHERE region = 'us-east-1' +AND data__Identifier = '<UserId>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/user_group/index.md b/docs/awscc-docs/providers/awscc/elasticache/user_group/index.md new file mode 100644 index 0000000000..42f99e446a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/user_group/index.md @@ -0,0 +1,81 @@ +--- +title: user_group +hide_title: false +hide_table_of_contents: false +keywords: + - user_group + - 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 +--- +Gets an individual user_group resource + +## Overview + + + + + +
Nameuser_group
TypeResource
Descriptionuser_group
Idawscc.elasticache.user_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
statusstringIndicates user group status. Can be "creating", "active", "modifying", "deleting".
user_group_idstringThe ID of the user group.
enginestringMust be redis.
user_idsarrayList of users associated to this user group.
arnstringThe Amazon Resource Name (ARN) of the user account.
tagsarrayAn array of key-value pairs to apply to this user.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_group resource, the following permissions are required: + +### Read +
+elasticache:DescribeUserGroups,
+elasticache:ListTagsForResource
+ +### Update +
+elasticache:ModifyUserGroup,
+elasticache:DescribeUserGroups,
+elasticache:ListTagsForResource,
+elasticache:AddTagsToResource,
+elasticache:RemoveTagsFromResource
+ +### Delete +
+elasticache:ModifyReplicationGroup,
+elasticache:DeleteUserGroup,
+elasticache:DescribeUserGroups,
+elasticache:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +status, +user_group_id, +engine, +user_ids, +arn, +tags +FROM awscc.elasticache.user_group +WHERE region = 'us-east-1' +AND data__Identifier = '<UserGroupId>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md b/docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md new file mode 100644 index 0000000000..bdd93c339d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md @@ -0,0 +1,61 @@ +--- +title: user_groups +hide_title: false +hide_table_of_contents: false +keywords: + - user_groups + - 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 +--- +Retrieves a list of user_groups in a region + +## Overview + + + + + +
Nameuser_groups
TypeResource
Descriptionuser_groups
Idawscc.elasticache.user_groups
+ +## Fields + + + + + +
NameDatatypeDescription
user_group_idstringThe ID of the user group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_groups resource, the following permissions are required: + +### Create +
+elasticache:CreateUserGroup,
+elasticache:DescribeUserGroups,
+elasticache:ListTagsForResource
+ +### List +
+elasticache:DescribeUserGroups,
+elasticache:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +user_group_id +FROM awscc.elasticache.user_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticache/users/index.md b/docs/awscc-docs/providers/awscc/elasticache/users/index.md new file mode 100644 index 0000000000..917d486f74 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticache/users/index.md @@ -0,0 +1,61 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - 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 +--- +Retrieves a list of users in a region + +## Overview + + + + + +
Nameusers
TypeResource
Descriptionusers
Idawscc.elasticache.users
+ +## Fields + + + + + +
NameDatatypeDescription
user_idstringThe ID of the user.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +
+elasticache:CreateUser,
+elasticache:DescribeUsers,
+elasticache:ListTagsForResource
+ +### List +
+elasticache:DescribeUsers,
+elasticache:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +user_id +FROM awscc.elasticache.users +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md new file mode 100644 index 0000000000..ce90475dbb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md @@ -0,0 +1,68 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.elasticbeanstalk.application
+ +## Fields + + + + + + + +
NameDatatypeDescription
application_namestringA 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.
descriptionstringYour description of the application.
resource_lifecycle_configobjectSpecifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+elasticbeanstalk:DescribeApplications
+ +### Update +
+elasticbeanstalk:UpdateApplication,
+elasticbeanstalk:UpdateApplicationResourceLifecycle
+ +### Delete +
+elasticbeanstalk:DeleteApplication
+ + +## Example +```sql +SELECT +region, +application_name, +description, +resource_lifecycle_config +FROM awscc.elasticbeanstalk.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md new file mode 100644 index 0000000000..0bee025bcd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md @@ -0,0 +1,70 @@ +--- +title: application_version +hide_title: false +hide_table_of_contents: false +keywords: + - application_version + - 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 +--- +Gets an individual application_version resource + +## Overview + + + + + +
Nameapplication_version
TypeResource
Descriptionapplication_version
Idawscc.elasticbeanstalk.application_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
application_namestringThe name of the Elastic Beanstalk application that is associated with this application version.
descriptionstringA description of this application version.
source_bundleobjectThe Amazon S3 bucket and key that identify the location of the source bundle for this version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_version resource, the following permissions are required: + +### Read +
+elasticbeanstalk:DescribeApplicationVersions
+ +### Update +
+elasticbeanstalk:UpdateApplicationVersion
+ +### Delete +
+elasticbeanstalk:DeleteApplicationVersion
+ + +## Example +```sql +SELECT +region, +id, +application_name, +description, +source_bundle +FROM awscc.elasticbeanstalk.application_version +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationName>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md new file mode 100644 index 0000000000..f574cd1ab1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md @@ -0,0 +1,63 @@ +--- +title: application_versions +hide_title: false +hide_table_of_contents: false +keywords: + - application_versions + - 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 +--- +Retrieves a list of application_versions in a region + +## Overview + + + + + +
Nameapplication_versions
TypeResource
Descriptionapplication_versions
Idawscc.elasticbeanstalk.application_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
application_namestringThe name of the Elastic Beanstalk application that is associated with this application version.
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_versions resource, the following permissions are required: + +### Create +
+elasticbeanstalk:CreateApplicationVersion,
+elasticbeanstalk:DescribeApplicationVersions,
+s3:GetObject,
+s3:PutObject
+ +### List +
+elasticbeanstalk:DescribeApplicationVersions
+ + +## Example +```sql +SELECT +region, +application_name, +id +FROM awscc.elasticbeanstalk.application_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md new file mode 100644 index 0000000000..204a26ff20 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md @@ -0,0 +1,58 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.elasticbeanstalk.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_namestringA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+elasticbeanstalk:CreateApplication
+ +### List +
+elasticbeanstalk:DescribeApplications
+ + +## Example +```sql +SELECT +region, +application_name +FROM awscc.elasticbeanstalk.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md new file mode 100644 index 0000000000..d25a8e5794 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md @@ -0,0 +1,79 @@ +--- +title: configuration_template +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_template + - 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 +--- +Gets an individual configuration_template resource + +## Overview + + + + + +
Nameconfiguration_template
TypeResource
Descriptionconfiguration_template
Idawscc.elasticbeanstalk.configuration_template
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
application_namestringThe name of the Elastic Beanstalk application to associate with this configuration template.
descriptionstringAn optional description for this configuration.
environment_idstringThe 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.
option_settingsarrayOption 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.
platform_arnstringThe 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.
solution_stack_namestringThe 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.<br/><br/> You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.<br/><br/> Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
source_configurationobjectAn 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.<br/><br/>Values specified in OptionSettings override any values obtained from the SourceConfiguration.<br/><br/>You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.<br/><br/>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.
template_namestringThe name of the configuration template
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_template resource, the following permissions are required: + +### Read +
+elasticbeanstalk:DescribeConfigurationSettings
+ +### Update +
+elasticbeanstalk:UpdateConfigurationTemplate
+ +### Delete +
+elasticbeanstalk:DeleteConfigurationTemplate,
+elasticbeanstalk:DescribeConfigurationSettings
+ + +## Example +```sql +SELECT +region, +application_name, +description, +environment_id, +option_settings, +platform_arn, +solution_stack_name, +source_configuration, +template_name +FROM awscc.elasticbeanstalk.configuration_template +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationName>' +AND data__Identifier = '<TemplateName>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md new file mode 100644 index 0000000000..d3da376c87 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md @@ -0,0 +1,60 @@ +--- +title: configuration_templates +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_templates + - 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 +--- +Retrieves a list of configuration_templates in a region + +## Overview + + + + + +
Nameconfiguration_templates
TypeResource
Descriptionconfiguration_templates
Idawscc.elasticbeanstalk.configuration_templates
+ +## Fields + + + + + + +
NameDatatypeDescription
application_namestringThe name of the Elastic Beanstalk application to associate with this configuration template.
template_namestringThe name of the configuration template
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_templates resource, the following permissions are required: + +### Create +
+elasticbeanstalk:CreateConfigurationTemplate
+ +### List +
+elasticbeanstalk:DescribeApplications
+ + +## Example +```sql +SELECT +region, +application_name, +template_name +FROM awscc.elasticbeanstalk.configuration_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md new file mode 100644 index 0000000000..65521f105f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md @@ -0,0 +1,95 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.elasticbeanstalk.environment
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
platform_arnstringThe Amazon Resource Name (ARN) of the custom platform to use with the environment.
application_namestringThe name of the application that is associated with this environment.
descriptionstringYour description for this environment.
environment_namestringA unique name for the environment.
operations_rolestringThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
tierobjectSpecifies 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.
version_labelstringThe name of the application version to deploy.
endpoint_ur_lstring
option_settingsarrayKey-value pairs defining configuration options for this environment, such as the instance type.
template_namestringThe name of the Elastic Beanstalk configuration template to use with the environment.
solution_stack_namestringThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
c_na_me_prefixstringIf 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.
tagsarraySpecifies the tags applied to resources in the environment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+elasticbeanstalk:DescribeEnvironments,
+elasticbeanstalk:DescribeConfigurationSettings,
+elasticbeanstalk:ListTagsForResource
+ +### Update +
+elasticbeanstalk:DescribeEnvironments,
+elasticbeanstalk:UpdateEnvironment,
+elasticbeanstalk:UpdateTagsForResource,
+elasticbeanstalk:AssociateEnvironmentOperationsRole,
+elasticbeanstalk:DisassociateEnvironmentOperationsRole,
+iam:PassRole
+ +### Delete +
+elasticbeanstalk:DescribeEnvironments,
+elasticbeanstalk:TerminateEnvironment
+ + +## Example +```sql +SELECT +region, +platform_arn, +application_name, +description, +environment_name, +operations_role, +tier, +version_label, +endpoint_ur_l, +option_settings, +template_name, +solution_stack_name, +c_na_me_prefix, +tags +FROM awscc.elasticbeanstalk.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<EnvironmentName>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md new file mode 100644 index 0000000000..560a8fa96e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md @@ -0,0 +1,60 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.elasticbeanstalk.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_namestringA unique name for the environment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+elasticbeanstalk:DescribeEnvironments,
+elasticbeanstalk:CreateEnvironment,
+iam:PassRole
+ +### List +
+elasticbeanstalk:DescribeEnvironments
+ + +## Example +```sql +SELECT +region, +environment_name +FROM awscc.elasticbeanstalk.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md new file mode 100644 index 0000000000..c8669aefaf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md @@ -0,0 +1,45 @@ +--- +title: elasticbeanstalk +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The elasticbeanstalk service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+application
+application_version
+application_versions
+applications +
+
+configuration_template
+configuration_templates
+environment
+environments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/index.md new file mode 100644 index 0000000000..95484f84a5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/index.md @@ -0,0 +1,49 @@ +--- +title: elasticloadbalancingv2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The elasticloadbalancingv2 service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+listener
+listener_rule
+listener_rules
+listeners
+load_balancer
+load_balancers +
+
+target_group
+target_groups
+trust_store
+trust_store_revocation
+trust_store_revocations
+trust_stores +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener/index.md new file mode 100644 index 0000000000..fcbff8c6bb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener/index.md @@ -0,0 +1,82 @@ +--- +title: listener +hide_title: false +hide_table_of_contents: false +keywords: + - listener + - 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 +--- +Gets an individual listener resource + +## Overview + + + + + +
Namelistener
TypeResource
Descriptionlistener
Idawscc.elasticloadbalancingv2.listener
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
ssl_policystring[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.<br/> 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*.
load_balancer_arnstringThe Amazon Resource Name (ARN) of the load balancer.
default_actionsarrayThe actions for the default rule. You cannot define a condition for a default rule.<br/> 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).
portintegerThe port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
certificatesarrayThe default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.<br/> 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).
protocolstringThe 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.
listener_arnstring
alpn_policyarray[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
mutual_authenticationobjectThe mutual authentication configuration information.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listener resource, the following permissions are required: + +### Delete +
+elasticloadbalancing:DeleteListener,
+elasticloadbalancing:DescribeListeners
+ +### Read +
+elasticloadbalancing:DescribeListeners
+ +### Update +
+elasticloadbalancing:ModifyListener,
+elasticloadbalancing:DescribeListeners,
+cognito-idp:DescribeUserPoolClient
+ + +## Example +```sql +SELECT +region, +ssl_policy, +load_balancer_arn, +default_actions, +port, +certificates, +protocol, +listener_arn, +alpn_policy, +mutual_authentication +FROM awscc.elasticloadbalancingv2.listener +WHERE region = 'us-east-1' +AND data__Identifier = '<ListenerArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md new file mode 100644 index 0000000000..3d712cbd64 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md @@ -0,0 +1,76 @@ +--- +title: listener_rule +hide_title: false +hide_table_of_contents: false +keywords: + - listener_rule + - 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 +--- +Gets an individual listener_rule resource + +## Overview + + + + + +
Namelistener_rule
TypeResource
Descriptionlistener_rule
Idawscc.elasticloadbalancingv2.listener_rule
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
listener_arnstring
rule_arnstring
actionsarray
priorityinteger
conditionsarray
is_defaultboolean
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listener_rule resource, the following permissions are required: + +### Delete +
+elasticloadbalancing:DeleteRule,
+elasticloadbalancing:DescribeRules
+ +### Read +
+elasticloadbalancing:DescribeRules
+ +### Update +
+elasticloadbalancing:ModifyRule,
+elasticloadbalancing:SetRulePriorities,
+elasticloadbalancing:DescribeRules
+ + +## Example +```sql +SELECT +region, +listener_arn, +rule_arn, +actions, +priority, +conditions, +is_default +FROM awscc.elasticloadbalancingv2.listener_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<RuleArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md new file mode 100644 index 0000000000..0d26e863a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md @@ -0,0 +1,60 @@ +--- +title: listener_rules +hide_title: false +hide_table_of_contents: false +keywords: + - listener_rules + - 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 +--- +Retrieves a list of listener_rules in a region + +## Overview + + + + + +
Namelistener_rules
TypeResource
Descriptionlistener_rules
Idawscc.elasticloadbalancingv2.listener_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listener_rules resource, the following permissions are required: + +### Create +
+elasticloadbalancing:CreateRule,
+elasticloadbalancing:DescribeRules,
+cognito-idp:DescribeUserPoolClient
+ +### List +
+elasticloadbalancing:DescribeRules
+ + +## Example +```sql +SELECT +region, +rule_arn +FROM awscc.elasticloadbalancingv2.listener_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md new file mode 100644 index 0000000000..5308d93217 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md @@ -0,0 +1,60 @@ +--- +title: listeners +hide_title: false +hide_table_of_contents: false +keywords: + - listeners + - 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 +--- +Retrieves a list of listeners in a region + +## Overview + + + + + +
Namelisteners
TypeResource
Descriptionlisteners
Idawscc.elasticloadbalancingv2.listeners
+ +## Fields + + + + + +
NameDatatypeDescription
listener_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Create +
+elasticloadbalancing:CreateListener,
+elasticloadbalancing:DescribeListeners,
+cognito-idp:DescribeUserPoolClient
+ +### List +
+elasticloadbalancing:DescribeListeners
+ + +## Example +```sql +SELECT +region, +listener_arn +FROM awscc.elasticloadbalancingv2.listeners +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md new file mode 100644 index 0000000000..c8683c472f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md @@ -0,0 +1,99 @@ +--- +title: load_balancer +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer + - 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 +--- +Gets an individual load_balancer resource + +## Overview + + + + + +
Nameload_balancer
TypeResource
Descriptionload_balancer
Idawscc.elasticloadbalancingv2.load_balancer
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ip_address_typestringThe 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.
security_groupsarray[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
load_balancer_attributesarrayThe load balancer attributes.
schemestringThe 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.<br/> 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.<br/> The default is an Internet-facing load balancer.<br/> You cannot specify a scheme for a Gateway Load Balancer.
d_ns_namestring
namestringThe 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-".<br/> 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.
load_balancer_namestring
load_balancer_full_namestring
subnetsarrayThe IDs of the public 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.<br/> [Application Load Balancers] You must specify subnets from at least two Availability Zones.<br/> [Application Load Balancers on Outposts] You must specify one Outpost subnet.<br/> [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.<br/> [Network Load Balancers] You can specify subnets from one or more Availability Zones.<br/> [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
typestringThe type of load balancer. The default is ``application``.
canonical_hosted_zone_idstring
tagsarrayThe tags to assign to the load balancer.
load_balancer_arnstring
subnet_mappingsarrayThe IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.<br/> [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.<br/> [Application Load Balancers on Outposts] You must specify one Outpost subnet.<br/> [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.<br/> [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.<br/> [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP
enforce_security_group_inbound_rules_on_private_link_trafficstringIndicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the load_balancer resource, the following permissions are required: + +### Delete +
+elasticloadbalancing:DescribeLoadBalancers,
+elasticloadbalancing:DeleteLoadBalancer
+ +### Read +
+elasticloadbalancing:DescribeLoadBalancers,
+elasticloadbalancing:DescribeLoadBalancerAttributes,
+elasticloadbalancing:DescribeTags
+ +### Update +
+elasticloadbalancing:ModifyLoadBalancerAttributes,
+elasticloadbalancing:SetSubnets,
+elasticloadbalancing:SetIpAddressType,
+elasticloadbalancing:SetSecurityGroups,
+elasticloadbalancing:AddTags,
+elasticloadbalancing:RemoveTags
+ + +## Example +```sql +SELECT +region, +ip_address_type, +security_groups, +load_balancer_attributes, +scheme, +d_ns_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 awscc.elasticloadbalancingv2.load_balancer +WHERE region = 'us-east-1' +AND data__Identifier = '<LoadBalancerArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md new file mode 100644 index 0000000000..9344108261 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md @@ -0,0 +1,61 @@ +--- +title: load_balancers +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancers + - 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 +--- +Retrieves a list of load_balancers in a region + +## Overview + + + + + +
Nameload_balancers
TypeResource
Descriptionload_balancers
Idawscc.elasticloadbalancingv2.load_balancers
+ +## Fields + + + + + +
NameDatatypeDescription
load_balancer_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the load_balancers resource, the following permissions are required: + +### Create +
+elasticloadbalancing:CreateLoadBalancer,
+elasticloadbalancing:DescribeLoadBalancers,
+elasticloadbalancing:ModifyLoadBalancerAttributes,
+elasticloadbalancing:AddTags
+ +### List +
+elasticloadbalancing:DescribeLoadBalancers
+ + +## Example +```sql +SELECT +region, +load_balancer_arn +FROM awscc.elasticloadbalancingv2.load_balancers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md new file mode 100644 index 0000000000..ab36e2bb24 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md @@ -0,0 +1,118 @@ +--- +title: target_group +hide_title: false +hide_table_of_contents: false +keywords: + - target_group + - 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 +--- +Gets an individual target_group resource + +## Overview + + + + + +
Nametarget_group
TypeResource
Descriptiontarget_group
Idawscc.elasticloadbalancingv2.target_group
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ip_address_typestringThe type of IP address used for this target group. The possible values are ipv4 and ipv6.
health_check_interval_secondsintegerThe approximate amount of time, in seconds, between health checks of an individual target.
load_balancer_arnsarrayThe Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
matcherobject[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
health_check_pathstring[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.
portintegerThe 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.
targetsarrayThe targets.
health_check_enabledbooleanIndicates 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.
protocol_versionstring[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
unhealthy_threshold_countintegerThe number of consecutive health check failures required before considering a target unhealthy.
health_check_timeout_secondsintegerThe amount of time, in seconds, during which no response from a target means a failed health check.
namestringThe name of the target group.
vpc_idstringThe identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
target_group_full_namestringThe full name of the target group.
healthy_threshold_countintegerThe number of consecutive health checks successes required before considering an unhealthy target healthy.
health_check_protocolstringThe protocol the load balancer uses when performing health checks on targets.
target_group_attributesarrayThe attributes.
target_typestringThe 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.
health_check_portstringThe port the load balancer uses when performing health checks on targets.
target_group_arnstringThe ARN of the Target Group
protocolstringThe protocol to use for routing traffic to the targets.
target_group_namestringThe name of the target group.
tagsarrayThe tags.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the target_group resource, the following permissions are required: + +### Delete +
+elasticloadbalancing:DeleteTargetGroup,
+elasticloadbalancing:DescribeTargetGroups
+ +### Read +
+elasticloadbalancing:DescribeTargetGroups,
+elasticloadbalancing:DescribeTargetGroupAttributes,
+elasticloadbalancing:DescribeTargetHealth,
+elasticloadbalancing:DescribeTags
+ +### Update +
+elasticloadbalancing:DescribeTargetGroups,
+elasticloadbalancing:ModifyTargetGroup,
+elasticloadbalancing:ModifyTargetGroupAttributes,
+elasticloadbalancing:RegisterTargets,
+elasticloadbalancing:DescribeTargetHealth,
+elasticloadbalancing:DeregisterTargets,
+elasticloadbalancing:AddTags,
+elasticloadbalancing:RemoveTags
+ + +## Example +```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, +tags +FROM awscc.elasticloadbalancingv2.target_group +WHERE region = 'us-east-1' +AND data__Identifier = '<TargetGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md new file mode 100644 index 0000000000..e4de12964a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md @@ -0,0 +1,63 @@ +--- +title: target_groups +hide_title: false +hide_table_of_contents: false +keywords: + - target_groups + - 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 +--- +Retrieves a list of target_groups in a region + +## Overview + + + + + +
Nametarget_groups
TypeResource
Descriptiontarget_groups
Idawscc.elasticloadbalancingv2.target_groups
+ +## Fields + + + + + +
NameDatatypeDescription
target_group_arnstringThe ARN of the Target Group
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the target_groups resource, the following permissions are required: + +### Create +
+elasticloadbalancing:CreateTargetGroup,
+elasticloadbalancing:DescribeTargetGroups,
+elasticloadbalancing:RegisterTargets,
+elasticloadbalancing:ModifyTargetGroupAttributes,
+elasticloadbalancing:DescribeTargetHealth,
+elasticloadbalancing:AddTags
+ +### List +
+elasticloadbalancing:DescribeTargetGroups
+ + +## Example +```sql +SELECT +region, +target_group_arn +FROM awscc.elasticloadbalancingv2.target_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md new file mode 100644 index 0000000000..8fdb748cb2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md @@ -0,0 +1,83 @@ +--- +title: trust_store +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store + - 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 +--- +Gets an individual trust_store resource + +## Overview + + + + + +
Nametrust_store
TypeResource
Descriptiontrust_store
Idawscc.elasticloadbalancingv2.trust_store
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the trust store.
ca_certificates_bundle_s3_bucketstringThe name of the S3 bucket to fetch the CA certificate bundle from.
ca_certificates_bundle_s3_keystringThe name of the S3 object to fetch the CA certificate bundle from.
ca_certificates_bundle_s3_object_versionstringThe version of the S3 bucket that contains the CA certificate bundle.
statusstringThe status of the trust store, could be either of ACTIVE or CREATING.
number_of_ca_certificatesintegerThe number of certificates associated with the trust store.
tagsarrayThe tags to assign to the trust store.
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_store resource, the following permissions are required: + +### Delete +
+elasticloadbalancing:DescribeTrustStores,
+elasticloadbalancing:DeleteTrustStore
+ +### Read +
+elasticloadbalancing:DescribeTrustStores,
+elasticloadbalancing:DescribeTags
+ +### Update +
+elasticloadbalancing:ModifyTrustStore,
+elasticloadbalancing:AddTags,
+elasticloadbalancing:RemoveTags,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```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 awscc.elasticloadbalancingv2.trust_store +WHERE region = 'us-east-1' +AND data__Identifier = '<TrustStoreArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocation/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocation/index.md new file mode 100644 index 0000000000..44920b17c7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocation/index.md @@ -0,0 +1,67 @@ +--- +title: trust_store_revocation +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_revocation + - 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 +--- +Gets an individual trust_store_revocation resource + +## Overview + + + + + +
Nametrust_store_revocation
TypeResource
Descriptiontrust_store_revocation
Idawscc.elasticloadbalancingv2.trust_store_revocation
+ +## Fields + + + + + + + + +
NameDatatypeDescription
revocation_contentsarrayThe attributes required to create a trust store revocation.
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
revocation_idintegerThe ID associated with the revocation.
trust_store_revocationsarrayThe data associated with a trust store revocation
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_store_revocation resource, the following permissions are required: + +### Delete +
+elasticloadbalancing:DescribeTrustStoreRevocations,
+elasticloadbalancing:RemoveTrustStoreRevocations
+ +### Read +
+elasticloadbalancing:DescribeTrustStoreRevocations
+ + +## Example +```sql +SELECT +region, +revocation_contents, +trust_store_arn, +revocation_id, +trust_store_revocations +FROM awscc.elasticloadbalancingv2.trust_store_revocation +WHERE region = 'us-east-1' +AND data__Identifier = '<RevocationId>' +AND data__Identifier = '<TrustStoreArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocations/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocations/index.md new file mode 100644 index 0000000000..b0dad1b23e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocations/index.md @@ -0,0 +1,63 @@ +--- +title: trust_store_revocations +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_revocations + - 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 +--- +Retrieves a list of trust_store_revocations in a region + +## Overview + + + + + +
Nametrust_store_revocations
TypeResource
Descriptiontrust_store_revocations
Idawscc.elasticloadbalancingv2.trust_store_revocations
+ +## Fields + + + + + + +
NameDatatypeDescription
revocation_idintegerThe ID associated with the revocation.
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_store_revocations resource, the following permissions are required: + +### Create +
+elasticloadbalancing:AddTrustStoreRevocations,
+elasticloadbalancing:DescribeTrustStoreRevocations,
+s3:GetObject,
+s3:GetObjectVersion
+ +### List +
+elasticloadbalancing:DescribeTrustStoreRevocations
+ + +## Example +```sql +SELECT +region, +revocation_id, +trust_store_arn +FROM awscc.elasticloadbalancingv2.trust_store_revocations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md new file mode 100644 index 0000000000..31928b85d7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md @@ -0,0 +1,64 @@ +--- +title: trust_stores +hide_title: false +hide_table_of_contents: false +keywords: + - trust_stores + - 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 +--- +Retrieves a list of trust_stores in a region + +## Overview + + + + + +
Nametrust_stores
TypeResource
Descriptiontrust_stores
Idawscc.elasticloadbalancingv2.trust_stores
+ +## Fields + + + + + +
NameDatatypeDescription
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_stores resource, the following permissions are required: + +### Create +
+elasticloadbalancing:CreateTrustStore,
+elasticloadbalancing:DescribeTrustStores,
+elasticloadbalancing:AddTags,
+s3:GetObject,
+s3:GetObjectVersion
+ +### List +
+elasticloadbalancing:DescribeTrustStores,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```sql +SELECT +region, +trust_store_arn +FROM awscc.elasticloadbalancingv2.trust_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/index.md b/docs/awscc-docs/providers/awscc/emr/index.md new file mode 100644 index 0000000000..a5ba186d24 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/index.md @@ -0,0 +1,47 @@ +--- +title: emr +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The emr service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+security_configuration
+security_configurations
+step
+steps
+studio +
+
+studio_session_mapping
+studio_session_mappings
+studios
+wal_workspace
+wal_workspaces +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/emr/security_configuration/index.md b/docs/awscc-docs/providers/awscc/emr/security_configuration/index.md new file mode 100644 index 0000000000..26e135be4d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/security_configuration/index.md @@ -0,0 +1,61 @@ +--- +title: security_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - security_configuration + - 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 +--- +Gets an individual security_configuration resource + +## Overview + + + + + +
Namesecurity_configuration
TypeResource
Descriptionsecurity_configuration
Idawscc.emr.security_configuration
+ +## Fields + + + + + + +
NameDatatypeDescription
namestringThe name of the security configuration.
security_configurationobjectThe security configuration details in JSON format.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_configuration resource, the following permissions are required: + +### Read +
+elasticmapreduce:DescribeSecurityConfiguration
+ +### Delete +
+elasticmapreduce:DeleteSecurityConfiguration
+ + +## Example +```sql +SELECT +region, +name, +security_configuration +FROM awscc.emr.security_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/security_configurations/index.md b/docs/awscc-docs/providers/awscc/emr/security_configurations/index.md new file mode 100644 index 0000000000..fe1de1440b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/security_configurations/index.md @@ -0,0 +1,59 @@ +--- +title: security_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - security_configurations + - 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 +--- +Retrieves a list of security_configurations in a region + +## Overview + + + + + +
Namesecurity_configurations
TypeResource
Descriptionsecurity_configurations
Idawscc.emr.security_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the security configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_configurations resource, the following permissions are required: + +### Create +
+elasticmapreduce:CreateSecurityConfiguration,
+elasticmapreduce:DescribeSecurityConfiguration
+ +### List +
+elasticmapreduce:ListSecurityConfigurations
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.emr.security_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/step/index.md b/docs/awscc-docs/providers/awscc/emr/step/index.md new file mode 100644 index 0000000000..b21a95c352 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/step/index.md @@ -0,0 +1,63 @@ +--- +title: step +hide_title: false +hide_table_of_contents: false +keywords: + - step + - 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 +--- +Gets an individual step resource + +## Overview + + + + + +
Namestep
TypeResource
Descriptionstep
Idawscc.emr.step
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstringID generated by service
action_on_failurestringThis specifies what action to take when the cluster step fails. Possible values are CANCEL_AND_WAIT and CONTINUE.
hadoop_jar_stepobjectThe HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps.
job_flow_idstringA string that uniquely identifies the cluster (job flow).
namestringThe name of the cluster step.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the step resource, the following permissions are required: + +### Delete +
+
+ + +## Example +```sql +SELECT +region, +id, +action_on_failure, +hadoop_jar_step, +job_flow_id, +name +FROM awscc.emr.step +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/steps/index.md b/docs/awscc-docs/providers/awscc/emr/steps/index.md new file mode 100644 index 0000000000..0f996a418e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/steps/index.md @@ -0,0 +1,54 @@ +--- +title: steps +hide_title: false +hide_table_of_contents: false +keywords: + - steps + - 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 +--- +Retrieves a list of steps in a region + +## Overview + + + + + +
Namesteps
TypeResource
Descriptionsteps
Idawscc.emr.steps
+ +## Fields + + + + + +
NameDatatypeDescription
idstringID generated by service
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the steps resource, the following permissions are required: + +### Create +
+emr:AddJobFlowSteps
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.emr.steps +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/studio/index.md b/docs/awscc-docs/providers/awscc/emr/studio/index.md new file mode 100644 index 0000000000..ead740fa69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/studio/index.md @@ -0,0 +1,107 @@ +--- +title: studio +hide_title: false +hide_table_of_contents: false +keywords: + - studio + - 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 +--- +Gets an individual studio resource + +## Overview + + + + + +
Namestudio
TypeResource
Descriptionstudio
Idawscc.emr.studio
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the EMR Studio.
auth_modestringSpecifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
default_s3_locationstringThe 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.
descriptionstringA detailed description of the Studio.
engine_security_group_idstringThe 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.
namestringA descriptive name for the Amazon EMR Studio.
service_rolestringThe 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.
studio_idstringThe ID of the EMR Studio.
subnet_idsarrayA 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.
tagsarrayA 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.
urlstringThe unique Studio access URL.
user_rolestringThe 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.
vpc_idstringThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
workspace_security_group_idstringThe 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.
idp_auth_urlstringYour 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.
idp_relay_state_parameter_namestringThe name of relay state parameter for external Identity Provider.
trusted_identity_propagation_enabledbooleanA Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
idc_user_assignmentstringSpecifies 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.
idc_instance_arnstringThe ARN of the IAM Identity Center instance to create the Studio application.
encryption_key_arnstringThe AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studio resource, the following permissions are required: + +### Read +
+elasticmapreduce:DescribeStudio,
+sso:GetManagedApplicationInstance
+ +### Update +
+elasticmapreduce:UpdateStudio,
+elasticmapreduce:DescribeStudio,
+elasticmapreduce:AddTags,
+elasticmapreduce:RemoveTags
+ +### Delete +
+elasticmapreduce:DeleteStudio,
+elasticmapreduce:DescribeStudio,
+sso:DeleteManagedApplicationInstance
+ + +## Example +```sql +SELECT +region, +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 awscc.emr.studio +WHERE region = 'us-east-1' +AND data__Identifier = '<StudioId>' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/studio_session_mapping/index.md b/docs/awscc-docs/providers/awscc/emr/studio_session_mapping/index.md new file mode 100644 index 0000000000..db10ebfb15 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/studio_session_mapping/index.md @@ -0,0 +1,95 @@ +--- +title: studio_session_mapping +hide_title: false +hide_table_of_contents: false +keywords: + - studio_session_mapping + - 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 +--- +Gets an individual studio_session_mapping resource + +## Overview + + + + + +
Namestudio_session_mapping
TypeResource
Descriptionstudio_session_mapping
Idawscc.emr.studio_session_mapping
+ +## Fields + + + + + + + + +
NameDatatypeDescription
identity_namestringThe 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.
identity_typestringSpecifies whether the identity to map to the Studio is a user or a group.
session_policy_arnstringThe 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.
studio_idstringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studio_session_mapping resource, the following permissions are required: + +### Read +
+elasticmapreduce:GetStudioSessionMapping,
+sso-directory:SearchUsers,
+sso-directory:SearchGroups,
+sso-directory:DescribeUser,
+sso-directory:DescribeGroup,
+sso:GetManagedApplicationInstance,
+sso:DescribeInstance
+ +### Update +
+elasticmapreduce:GetStudioSessionMapping,
+elasticmapreduce:UpdateStudioSessionMapping,
+sso-directory:SearchUsers,
+sso-directory:SearchGroups,
+sso-directory:DescribeUser,
+sso-directory:DescribeGroup,
+sso:GetManagedApplicationInstance,
+sso:DescribeInstance
+ +### Delete +
+elasticmapreduce:GetStudioSessionMapping,
+elasticmapreduce:DeleteStudioSessionMapping,
+sso-directory:SearchUsers,
+sso-directory:SearchGroups,
+sso-directory:DescribeUser,
+sso-directory:DescribeGroup,
+sso:GetManagedApplicationInstance,
+sso:DescribeInstance,
+sso:ListDirectoryAssociations,
+sso:GetProfile,
+sso:ListProfiles,
+sso:DisassociateProfile
+ + +## Example +```sql +SELECT +region, +identity_name, +identity_type, +session_policy_arn, +studio_id +FROM awscc.emr.studio_session_mapping +WHERE region = 'us-east-1' +AND data__Identifier = '<StudioId>' +AND data__Identifier = '<IdentityType>' +AND data__Identifier = '<IdentityName>' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/studio_session_mappings/index.md b/docs/awscc-docs/providers/awscc/emr/studio_session_mappings/index.md new file mode 100644 index 0000000000..5c5346ef44 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/studio_session_mappings/index.md @@ -0,0 +1,70 @@ +--- +title: studio_session_mappings +hide_title: false +hide_table_of_contents: false +keywords: + - studio_session_mappings + - 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 +--- +Retrieves a list of studio_session_mappings in a region + +## Overview + + + + + +
Namestudio_session_mappings
TypeResource
Descriptionstudio_session_mappings
Idawscc.emr.studio_session_mappings
+ +## Fields + + + + + + + +
NameDatatypeDescription
studio_idstringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
identity_typestringSpecifies whether the identity to map to the Studio is a user or a group.
identity_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studio_session_mappings resource, the following permissions are required: + +### Create +
+elasticmapreduce:CreateStudioSessionMapping,
+sso-directory:SearchUsers,
+sso-directory:SearchGroups,
+sso-directory:DescribeUser,
+sso-directory:DescribeGroup,
+sso:ListDirectoryAssociations,
+sso:GetProfile,
+sso:ListProfiles,
+sso:AssociateProfile
+ +### List +
+elasticmapreduce:ListStudioSessionMappings
+ + +## Example +```sql +SELECT +region, +studio_id, +identity_type, +identity_name +FROM awscc.emr.studio_session_mappings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/studios/index.md b/docs/awscc-docs/providers/awscc/emr/studios/index.md new file mode 100644 index 0000000000..2e78e39bef --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/studios/index.md @@ -0,0 +1,63 @@ +--- +title: studios +hide_title: false +hide_table_of_contents: false +keywords: + - studios + - 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 +--- +Retrieves a list of studios in a region + +## Overview + + + + + +
Namestudios
TypeResource
Descriptionstudios
Idawscc.emr.studios
+ +## Fields + + + + + +
NameDatatypeDescription
studio_idstringThe ID of the EMR Studio.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studios resource, the following permissions are required: + +### Create +
+elasticmapreduce:CreateStudio,
+elasticmapreduce:DescribeStudio,
+elasticmapreduce:AddTags,
+sso:CreateManagedApplicationInstance,
+sso:DeleteManagedApplicationInstance,
+iam:PassRole
+ +### List +
+elasticmapreduce:ListStudios
+ + +## Example +```sql +SELECT +region, +studio_id +FROM awscc.emr.studios +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md b/docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md new file mode 100644 index 0000000000..a3b4898735 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md @@ -0,0 +1,67 @@ +--- +title: wal_workspace +hide_title: false +hide_table_of_contents: false +keywords: + - wal_workspace + - 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 +--- +Gets an individual wal_workspace resource + +## Overview + + + + + +
Namewal_workspace
TypeResource
Descriptionwal_workspace
Idawscc.emr.wal_workspace
+ +## Fields + + + + + + +
NameDatatypeDescription
w_al_workspace_namestringThe name of the emrwal container
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wal_workspace resource, the following permissions are required: + +### Read +
+emrwal:ListTagsForResource
+ +### Delete +
+emrwal:DeleteWorkspace
+ +### Update +
+emrwal:TagResource,
+emrwal:UntagResource,
+emrwal:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +w_al_workspace_name, +tags +FROM awscc.emr.wal_workspace +WHERE region = 'us-east-1' +AND data__Identifier = '<WALWorkspaceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md b/docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md new file mode 100644 index 0000000000..680f5a51f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md @@ -0,0 +1,60 @@ +--- +title: wal_workspaces +hide_title: false +hide_table_of_contents: false +keywords: + - wal_workspaces + - 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 +--- +Retrieves a list of wal_workspaces in a region + +## Overview + + + + + +
Namewal_workspaces
TypeResource
Descriptionwal_workspaces
Idawscc.emr.wal_workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
w_al_workspace_namestringThe name of the emrwal container
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wal_workspaces resource, the following permissions are required: + +### Create +
+emrwal:CreateWorkspace,
+emrwal:TagResource,
+iam:CreateServiceLinkedRole
+ +### List +
+emrwal:ListWorkspaces
+ + +## Example +```sql +SELECT +region, +w_al_workspace_name +FROM awscc.emr.wal_workspaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emrcontainers/index.md b/docs/awscc-docs/providers/awscc/emrcontainers/index.md new file mode 100644 index 0000000000..58fc4a3d44 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emrcontainers/index.md @@ -0,0 +1,39 @@ +--- +title: emrcontainers +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The emrcontainers service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+virtual_cluster +
+
+virtual_clusters +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/emrcontainers/virtual_cluster/index.md b/docs/awscc-docs/providers/awscc/emrcontainers/virtual_cluster/index.md new file mode 100644 index 0000000000..cc4b91dace --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emrcontainers/virtual_cluster/index.md @@ -0,0 +1,74 @@ +--- +title: virtual_cluster +hide_title: false +hide_table_of_contents: false +keywords: + - virtual_cluster + - 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 +--- +Gets an individual virtual_cluster resource + +## Overview + + + + + +
Namevirtual_cluster
TypeResource
Descriptionvirtual_cluster
Idawscc.emrcontainers.virtual_cluster
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
container_providerobjectContainer provider of the virtual cluster.
idstringId of the virtual cluster.
namestringName of the virtual cluster.
tagsarrayAn array of key-value pairs to apply to this virtual cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the virtual_cluster resource, the following permissions are required: + +### Read +
+emr-containers:DescribeVirtualCluster
+ +### Delete +
+emr-containers:DeleteVirtualCluster
+ +### Update +
+emr-containers:DescribeVirtualCluster,
+emr-containers:ListTagsForResource,
+emr-containers:TagResource,
+emr-containers:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +container_provider, +id, +name, +tags +FROM awscc.emrcontainers.virtual_cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md b/docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md new file mode 100644 index 0000000000..439d209366 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md @@ -0,0 +1,60 @@ +--- +title: virtual_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - virtual_clusters + - 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 +--- +Retrieves a list of virtual_clusters in a region + +## Overview + + + + + +
Namevirtual_clusters
TypeResource
Descriptionvirtual_clusters
Idawscc.emrcontainers.virtual_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId of the virtual cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the virtual_clusters resource, the following permissions are required: + +### Create +
+emr-containers:CreateVirtualCluster,
+emr-containers:TagResource,
+iam:CreateServiceLinkedRole
+ +### List +
+emr-containers:ListVirtualClusters
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.emrcontainers.virtual_clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emrserverless/application/index.md b/docs/awscc-docs/providers/awscc/emrserverless/application/index.md new file mode 100644 index 0000000000..963ba8f951 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emrserverless/application/index.md @@ -0,0 +1,117 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.emrserverless.application
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
architecturestring
namestringUser friendly Application name.
release_labelstringEMR release label.
typestringThe type of the application
initial_capacityarrayInitial capacity initialized when an Application is started.
maximum_capacityobjectMaximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit.
tagsarrayTag map with key and value
auto_start_configurationobjectConfiguration for Auto Start of Application.
auto_stop_configurationobjectConfiguration for Auto Stop of Application.
image_configurationobject
monitoring_configurationobject
runtime_configurationarray
network_configurationobjectNetwork Configuration for customer VPC connectivity.
arnstringThe Amazon Resource Name (ARN) of the EMR Serverless Application.
application_idstringThe ID of the EMR Serverless Application.
worker_type_specificationsobjectThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+emr-serverless:GetApplication
+ +### Update +
+emr-serverless:UpdateApplication,
+emr-serverless:TagResource,
+emr-serverless:UntagResource,
+emr-serverless:GetApplication,
+ec2:CreateNetworkInterface,
+ecr:BatchGetImage,
+ecr:DescribeImages,
+ecr:GetDownloadUrlForLayer,
+kms:Create*,
+kms:Describe*,
+kms:Enable*,
+kms:List*,
+kms:Put*,
+kms:Update*,
+kms:Revoke*,
+kms:Disable*,
+kms:Get*,
+kms:Delete*,
+kms:ScheduleKeyDeletion,
+kms:CancelKeyDeletion,
+kms:GenerateDataKey,
+kms:TagResource,
+kms:UntagResource,
+kms:Decrypt
+ +### Delete +
+emr-serverless:DeleteApplication,
+emr-serverless:GetApplication
+ + +## Example +```sql +SELECT +region, +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 awscc.emrserverless.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/emrserverless/applications/index.md b/docs/awscc-docs/providers/awscc/emrserverless/applications/index.md new file mode 100644 index 0000000000..e42db2d778 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emrserverless/applications/index.md @@ -0,0 +1,81 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.emrserverless.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_idstringThe ID of the EMR Serverless Application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+kms:Create*,
+kms:Describe*,
+kms:Enable*,
+kms:List*,
+kms:Put*,
+kms:Update*,
+kms:Revoke*,
+kms:Disable*,
+kms:Get*,
+kms:Delete*,
+kms:ScheduleKeyDeletion,
+kms:CancelKeyDeletion,
+kms:GenerateDataKey,
+kms:TagResource,
+kms:UntagResource,
+kms:Decrypt,
+emr-serverless:CreateApplication,
+emr-serverless:TagResource,
+emr-serverless:GetApplication,
+iam:CreateServiceLinkedRole,
+ec2:CreateNetworkInterface,
+ecr:BatchGetImage,
+ecr:DescribeImages,
+ecr:GetDownloadUrlForLayer
+ +### List +
+emr-serverless:ListApplications
+ + +## Example +```sql +SELECT +region, +application_id +FROM awscc.emrserverless.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/emrserverless/index.md b/docs/awscc-docs/providers/awscc/emrserverless/index.md new file mode 100644 index 0000000000..b70df90cfb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/emrserverless/index.md @@ -0,0 +1,39 @@ +--- +title: emrserverless +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The emrserverless service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+application +
+
+applications +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflow/index.md b/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflow/index.md new file mode 100644 index 0000000000..f92e7a1cd2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflow/index.md @@ -0,0 +1,91 @@ +--- +title: id_mapping_workflow +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_workflow + - 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 +--- +Gets an individual id_mapping_workflow resource + +## Overview + + + + + +
Nameid_mapping_workflow
TypeResource
Descriptionid_mapping_workflow
Idawscc.entityresolution.id_mapping_workflow
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
workflow_namestringThe name of the IdMappingWorkflow
descriptionstringThe description of the IdMappingWorkflow
input_source_configarray
output_source_configarray
id_mapping_techniquesobject
role_arnstring
tagsarray
workflow_arnstring
created_atstring
updated_atstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the id_mapping_workflow resource, the following permissions are required: + +### Update +
+entityresolution:GetIdMappingWorkflow,
+entityresolution:UpdateIdMappingWorkflow,
+entityresolution:ListTagsForResource,
+entityresolution:TagResource,
+entityresolution:UntagResource,
+iam:PassRole,
+kms:CreateGrant,
+kms:DescribeKey
+ +### Read +
+entityresolution:GetIdMappingWorkflow,
+entityresolution:ListTagsForResource
+ +### Delete +
+entityresolution:DeleteIdMappingWorkflow,
+entityresolution:GetIdMappingWorkflow,
+entityresolution:UntagResource
+ + +## Example +```sql +SELECT +region, +workflow_name, +description, +input_source_config, +output_source_config, +id_mapping_techniques, +role_arn, +tags, +workflow_arn, +created_at, +updated_at +FROM awscc.entityresolution.id_mapping_workflow +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkflowName>' +``` diff --git a/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflows/index.md b/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflows/index.md new file mode 100644 index 0000000000..2bd3ef620c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflows/index.md @@ -0,0 +1,63 @@ +--- +title: id_mapping_workflows +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_workflows + - 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 +--- +Retrieves a list of id_mapping_workflows in a region + +## Overview + + + + + +
Nameid_mapping_workflows
TypeResource
Descriptionid_mapping_workflows
Idawscc.entityresolution.id_mapping_workflows
+ +## Fields + + + + + +
NameDatatypeDescription
workflow_nameundefinedThe name of the IdMappingWorkflow
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the id_mapping_workflows resource, the following permissions are required: + +### Create +
+entityresolution:CreateIdMappingWorkflow,
+entityresolution:GetIdMappingWorkflow,
+entityresolution:TagResource,
+kms:CreateGrant,
+kms:DescribeKey,
+iam:PassRole
+ +### List +
+entityresolution:ListIdMappingWorkflows
+ + +## Example +```sql +SELECT +region, +workflow_name +FROM awscc.entityresolution.id_mapping_workflows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/entityresolution/index.md b/docs/awscc-docs/providers/awscc/entityresolution/index.md new file mode 100644 index 0000000000..f2e07f5168 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/entityresolution/index.md @@ -0,0 +1,43 @@ +--- +title: entityresolution +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The entityresolution service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+id_mapping_workflow
+id_mapping_workflows
+matching_workflow +
+
+matching_workflows
+schema_mapping
+schema_mappings +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/entityresolution/matching_workflow/index.md b/docs/awscc-docs/providers/awscc/entityresolution/matching_workflow/index.md new file mode 100644 index 0000000000..a371faa321 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/entityresolution/matching_workflow/index.md @@ -0,0 +1,91 @@ +--- +title: matching_workflow +hide_title: false +hide_table_of_contents: false +keywords: + - matching_workflow + - 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 +--- +Gets an individual matching_workflow resource + +## Overview + + + + + +
Namematching_workflow
TypeResource
Descriptionmatching_workflow
Idawscc.entityresolution.matching_workflow
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
workflow_namestringThe name of the MatchingWorkflow
descriptionstringThe description of the MatchingWorkflow
input_source_configarray
output_source_configarray
resolution_techniquesobject
role_arnstring
tagsarray
workflow_arnstring
created_atstring
updated_atstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the matching_workflow resource, the following permissions are required: + +### Read +
+entityresolution:GetMatchingWorkflow,
+entityresolution:ListTagsForResource
+ +### Delete +
+entityresolution:DeleteMatchingWorkflow,
+entityresolution:GetMatchingWorkflow,
+entityresolution:UntagResource
+ +### Update +
+entityresolution:GetMatchingWorkflow,
+entityresolution:UpdateMatchingWorkflow,
+entityresolution:ListTagsForResource,
+entityresolution:TagResource,
+entityresolution:UntagResource,
+iam:PassRole,
+kms:CreateGrant,
+kms:DescribeKey
+ + +## Example +```sql +SELECT +region, +workflow_name, +description, +input_source_config, +output_source_config, +resolution_techniques, +role_arn, +tags, +workflow_arn, +created_at, +updated_at +FROM awscc.entityresolution.matching_workflow +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkflowName>' +``` diff --git a/docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md b/docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md new file mode 100644 index 0000000000..7e2bc31dbc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md @@ -0,0 +1,63 @@ +--- +title: matching_workflows +hide_title: false +hide_table_of_contents: false +keywords: + - matching_workflows + - 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 +--- +Retrieves a list of matching_workflows in a region + +## Overview + + + + + +
Namematching_workflows
TypeResource
Descriptionmatching_workflows
Idawscc.entityresolution.matching_workflows
+ +## Fields + + + + + +
NameDatatypeDescription
workflow_nameundefinedThe name of the MatchingWorkflow
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the matching_workflows resource, the following permissions are required: + +### Create +
+entityresolution:CreateMatchingWorkflow,
+entityresolution:GetMatchingWorkflow,
+entityresolution:TagResource,
+kms:CreateGrant,
+kms:DescribeKey,
+iam:PassRole
+ +### List +
+entityresolution:ListMatchingWorkflows
+ + +## Example +```sql +SELECT +region, +workflow_name +FROM awscc.entityresolution.matching_workflows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md b/docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md new file mode 100644 index 0000000000..51c0064959 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md @@ -0,0 +1,83 @@ +--- +title: schema_mapping +hide_title: false +hide_table_of_contents: false +keywords: + - schema_mapping + - 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 +--- +Gets an individual schema_mapping resource + +## Overview + + + + + +
Nameschema_mapping
TypeResource
Descriptionschema_mapping
Idawscc.entityresolution.schema_mapping
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
schema_namestringThe name of the SchemaMapping
descriptionstringThe description of the SchemaMapping
mapped_input_fieldsarrayThe SchemaMapping attributes input
tagsarray
schema_arnstring
created_atstring
updated_atstring
has_workflowsboolean
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schema_mapping resource, the following permissions are required: + +### Read +
+entityresolution:GetSchemaMapping,
+entityresolution:ListTagsForResource
+ +### Delete +
+entityresolution:DeleteSchemaMapping,
+entityresolution:GetSchemaMapping
+ +### Update +
+entityresolution:GetSchemaMapping,
+entityresolution:UpdateSchemaMapping,
+entityresolution:ListTagsForResource,
+entityresolution:TagResource,
+entityresolution:UntagResource
+ + +## Example +```sql +SELECT +region, +schema_name, +description, +mapped_input_fields, +tags, +schema_arn, +created_at, +updated_at, +has_workflows +FROM awscc.entityresolution.schema_mapping +WHERE region = 'us-east-1' +AND data__Identifier = '<SchemaName>' +``` diff --git a/docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md b/docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md new file mode 100644 index 0000000000..1a4bac469e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md @@ -0,0 +1,60 @@ +--- +title: schema_mappings +hide_title: false +hide_table_of_contents: false +keywords: + - schema_mappings + - 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 +--- +Retrieves a list of schema_mappings in a region + +## Overview + + + + + +
Nameschema_mappings
TypeResource
Descriptionschema_mappings
Idawscc.entityresolution.schema_mappings
+ +## Fields + + + + + +
NameDatatypeDescription
schema_nameundefinedThe name of the SchemaMapping
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schema_mappings resource, the following permissions are required: + +### Create +
+entityresolution:CreateSchemaMapping,
+entityresolution:GetSchemaMapping,
+entityresolution:TagResource
+ +### List +
+entityresolution:ListSchemaMappings
+ + +## Example +```sql +SELECT +region, +schema_name +FROM awscc.entityresolution.schema_mappings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/events/api_destination/index.md b/docs/awscc-docs/providers/awscc/events/api_destination/index.md new file mode 100644 index 0000000000..3d83b5242a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/api_destination/index.md @@ -0,0 +1,77 @@ +--- +title: api_destination +hide_title: false +hide_table_of_contents: false +keywords: + - api_destination + - 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 +--- +Gets an individual api_destination resource + +## Overview + + + + + +
Nameapi_destination
TypeResource
Descriptionapi_destination
Idawscc.events.api_destination
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the apiDestination.
descriptionstring
connection_arnstringThe arn of the connection.
arnstringThe arn of the api destination.
invocation_rate_limit_per_secondinteger
invocation_endpointstringUrl endpoint to invoke.
http_methodstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_destination resource, the following permissions are required: + +### Read +
+events:DescribeApiDestination
+ +### Update +
+events:UpdateApiDestination,
+events:DescribeApiDestination
+ +### Delete +
+events:DeleteApiDestination,
+events:DescribeApiDestination
+ + +## Example +```sql +SELECT +region, +name, +description, +connection_arn, +arn, +invocation_rate_limit_per_second, +invocation_endpoint, +http_method +FROM awscc.events.api_destination +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/events/api_destinations/index.md b/docs/awscc-docs/providers/awscc/events/api_destinations/index.md new file mode 100644 index 0000000000..0fc891cfb7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/api_destinations/index.md @@ -0,0 +1,59 @@ +--- +title: api_destinations +hide_title: false +hide_table_of_contents: false +keywords: + - api_destinations + - 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 +--- +Retrieves a list of api_destinations in a region + +## Overview + + + + + +
Nameapi_destinations
TypeResource
Descriptionapi_destinations
Idawscc.events.api_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the apiDestination.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_destinations resource, the following permissions are required: + +### Create +
+events:CreateApiDestination,
+events:DescribeApiDestination
+ +### List +
+events:ListApiDestinations
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.events.api_destinations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/events/archive/index.md b/docs/awscc-docs/providers/awscc/events/archive/index.md new file mode 100644 index 0000000000..3fc2802d12 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/archive/index.md @@ -0,0 +1,75 @@ +--- +title: archive +hide_title: false +hide_table_of_contents: false +keywords: + - archive + - 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 +--- +Gets an individual archive resource + +## Overview + + + + + +
Namearchive
TypeResource
Descriptionarchive
Idawscc.events.archive
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
archive_namestring
source_arnstring
descriptionstring
event_patternobject
arnstring
retention_daysinteger
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the archive resource, the following permissions are required: + +### Delete +
+events:DescribeArchive,
+events:DeleteArchive
+ +### Update +
+events:DescribeArchive,
+events:UpdateArchive
+ +### Read +
+events:DescribeArchive
+ + +## Example +```sql +SELECT +region, +archive_name, +source_arn, +description, +event_pattern, +arn, +retention_days +FROM awscc.events.archive +WHERE region = 'us-east-1' +AND data__Identifier = '<ArchiveName>' +``` diff --git a/docs/awscc-docs/providers/awscc/events/archives/index.md b/docs/awscc-docs/providers/awscc/events/archives/index.md new file mode 100644 index 0000000000..18209550e6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/archives/index.md @@ -0,0 +1,59 @@ +--- +title: archives +hide_title: false +hide_table_of_contents: false +keywords: + - archives + - 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 +--- +Retrieves a list of archives in a region + +## Overview + + + + + +
Namearchives
TypeResource
Descriptionarchives
Idawscc.events.archives
+ +## Fields + + + + + +
NameDatatypeDescription
archive_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the archives resource, the following permissions are required: + +### Create +
+events:DescribeArchive,
+events:CreateArchive
+ +### List +
+events:ListArchives
+ + +## Example +```sql +SELECT +region, +archive_name +FROM awscc.events.archives +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/events/connection/index.md b/docs/awscc-docs/providers/awscc/events/connection/index.md new file mode 100644 index 0000000000..de1dfc11fc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/connection/index.md @@ -0,0 +1,79 @@ +--- +title: connection +hide_title: false +hide_table_of_contents: false +keywords: + - connection + - 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 +--- +Gets an individual connection resource + +## Overview + + + + + +
Nameconnection
TypeResource
Descriptionconnection
Idawscc.events.connection
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringName of the connection.
arnstringThe arn of the connection resource.
secret_arnstringThe arn of the secrets manager secret created in the customer account.
descriptionstringDescription of the connection.
authorization_typestring
auth_parametersobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connection resource, the following permissions are required: + +### Read +
+events:DescribeConnection
+ +### Update +
+events:UpdateConnection,
+events:DescribeConnection,
+secretsmanager:CreateSecret,
+secretsmanager:UpdateSecret,
+secretsmanager:GetSecretValue,
+secretsmanager:PutSecretValue
+ +### Delete +
+events:DeleteConnection,
+events:DescribeConnection
+ + +## Example +```sql +SELECT +region, +name, +arn, +secret_arn, +description, +authorization_type, +auth_parameters +FROM awscc.events.connection +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/events/connections/index.md b/docs/awscc-docs/providers/awscc/events/connections/index.md new file mode 100644 index 0000000000..1cec282722 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/connections/index.md @@ -0,0 +1,63 @@ +--- +title: connections +hide_title: false +hide_table_of_contents: false +keywords: + - connections + - 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 +--- +Retrieves a list of connections in a region + +## Overview + + + + + +
Nameconnections
TypeResource
Descriptionconnections
Idawscc.events.connections
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the connection.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connections resource, the following permissions are required: + +### Create +
+events:CreateConnection,
+events:DescribeConnection,
+secretsmanager:CreateSecret,
+secretsmanager:GetSecretValue,
+secretsmanager:PutSecretValue,
+iam:CreateServiceLinkedRole
+ +### List +
+events:ListConnections
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.events.connections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/events/endpoint/index.md b/docs/awscc-docs/providers/awscc/events/endpoint/index.md new file mode 100644 index 0000000000..58df6c4da6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/endpoint/index.md @@ -0,0 +1,87 @@ +--- +title: endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint + - 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 +--- +Gets an individual endpoint resource + +## Overview + + + + + +
Nameendpoint
TypeResource
Descriptionendpoint
Idawscc.events.endpoint
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
role_arnstring
descriptionstring
routing_configobject
replication_configobject
event_busesarray
endpoint_idstring
endpoint_urlstring
statestring
state_reasonstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint resource, the following permissions are required: + +### Read +
+events:DescribeEndpoint
+ +### Update +
+events:DescribeEndpoint,
+events:UpdateEndpoint,
+route53:GetHealthCheck,
+iam:PassRole
+ +### Delete +
+events:DeleteEndpoint,
+events:DescribeEndpoint
+ + +## Example +```sql +SELECT +region, +name, +arn, +role_arn, +description, +routing_config, +replication_config, +event_buses, +endpoint_id, +endpoint_url, +state, +state_reason +FROM awscc.events.endpoint +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/events/endpoints/index.md b/docs/awscc-docs/providers/awscc/events/endpoints/index.md new file mode 100644 index 0000000000..6046b9e26a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/endpoints/index.md @@ -0,0 +1,61 @@ +--- +title: endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints + - 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 +--- +Retrieves a list of endpoints in a region + +## Overview + + + + + +
Nameendpoints
TypeResource
Descriptionendpoints
Idawscc.events.endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoints resource, the following permissions are required: + +### Create +
+events:CreateEndpoint,
+events:DescribeEndpoint,
+route53:GetHealthCheck,
+iam:PassRole
+ +### List +
+events:ListEndpoints
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.events.endpoints +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/events/event_bus/index.md b/docs/awscc-docs/providers/awscc/events/event_bus/index.md new file mode 100644 index 0000000000..29143617fc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/event_bus/index.md @@ -0,0 +1,76 @@ +--- +title: event_bus +hide_title: false +hide_table_of_contents: false +keywords: + - event_bus + - 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 +--- +Gets an individual event_bus resource + +## Overview + + + + + +
Nameevent_bus
TypeResource
Descriptionevent_bus
Idawscc.events.event_bus
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
event_source_namestringIf you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
namestringThe name of the event bus.
tagsarrayAny tags assigned to the event bus.
policyobjectA JSON string that describes the permission policy statement for the event bus.
arnstringThe Amazon Resource Name (ARN) for the event bus.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_bus resource, the following permissions are required: + +### Read +
+events:DescribeEventBus,
+events:ListTagsForResource
+ +### Update +
+events:TagResource,
+events:UntagResource,
+events:PutPermission,
+events:DescribeEventBus
+ +### Delete +
+events:DescribeEventBus,
+events:DeleteEventBus
+ + +## Example +```sql +SELECT +region, +event_source_name, +name, +tags, +policy, +arn +FROM awscc.events.event_bus +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/events/event_buses/index.md b/docs/awscc-docs/providers/awscc/events/event_buses/index.md new file mode 100644 index 0000000000..d7999d1a04 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/event_buses/index.md @@ -0,0 +1,63 @@ +--- +title: event_buses +hide_title: false +hide_table_of_contents: false +keywords: + - event_buses + - 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 +--- +Retrieves a list of event_buses in a region + +## Overview + + + + + +
Nameevent_buses
TypeResource
Descriptionevent_buses
Idawscc.events.event_buses
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the event bus.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_buses resource, the following permissions are required: + +### Create +
+events:CreateEventBus,
+events:DescribeEventBus,
+events:PutPermission,
+events:ListTagsForResource,
+events:TagResource
+ +### List +
+events:ListEventBuses,
+events:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.events.event_buses +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/events/index.md b/docs/awscc-docs/providers/awscc/events/index.md new file mode 100644 index 0000000000..1033e811cd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/index.md @@ -0,0 +1,49 @@ +--- +title: events +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The events service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+api_destination
+api_destinations
+archive
+archives
+connection
+connections +
+
+endpoint
+endpoints
+event_bus
+event_buses
+rule
+rules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/events/rule/index.md b/docs/awscc-docs/providers/awscc/events/rule/index.md new file mode 100644 index 0000000000..a9c1ae7e41 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/rule/index.md @@ -0,0 +1,89 @@ +--- +title: rule +hide_title: false +hide_table_of_contents: false +keywords: + - rule + - 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 +--- +Gets an individual rule resource + +## Overview + + + + + +
Namerule
TypeResource
Descriptionrule
Idawscc.events.rule
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
event_bus_namestringThe name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
event_patternobjectThe event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
schedule_expressionstringThe scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
descriptionstringThe description of the rule.
statestringThe state of the rule.
targetsarrayAdds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.<br/>Targets are the resources that are invoked when a rule is triggered.
arnstringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
role_arnstringThe Amazon Resource Name (ARN) of the role that is used for target invocation.
namestringThe name of the rule.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule resource, the following permissions are required: + +### Read +
+iam:PassRole,
+events:DescribeRule,
+events:ListTargetsByRule
+ +### Update +
+iam:PassRole,
+events:DescribeRule,
+events:PutRule,
+events:RemoveTargets,
+events:PutTargets
+ +### Delete +
+iam:PassRole,
+events:DescribeRule,
+events:DeleteRule,
+events:RemoveTargets,
+events:ListTargetsByRule
+ + +## Example +```sql +SELECT +region, +event_bus_name, +event_pattern, +schedule_expression, +description, +state, +targets, +arn, +role_arn, +name +FROM awscc.events.rule +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/events/rules/index.md b/docs/awscc-docs/providers/awscc/events/rules/index.md new file mode 100644 index 0000000000..880742fde5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/events/rules/index.md @@ -0,0 +1,61 @@ +--- +title: rules +hide_title: false +hide_table_of_contents: false +keywords: + - rules + - 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 +--- +Retrieves a list of rules in a region + +## Overview + + + + + +
Namerules
TypeResource
Descriptionrules
Idawscc.events.rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Create +
+iam:PassRole,
+events:DescribeRule,
+events:PutRule,
+events:PutTargets
+ +### List +
+events:ListRules
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.events.rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md b/docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md new file mode 100644 index 0000000000..8a773db8e7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md @@ -0,0 +1,85 @@ +--- +title: discoverer +hide_title: false +hide_table_of_contents: false +keywords: + - discoverer + - 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 +--- +Gets an individual discoverer resource + +## Overview + + + + + +
Namediscoverer
TypeResource
Descriptiondiscoverer
Idawscc.eventschemas.discoverer
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
discoverer_arnstringThe ARN of the discoverer.
discoverer_idstringThe Id of the discoverer.
descriptionstringA description for the discoverer.
source_arnstringThe ARN of the event bus.
cross_accountbooleanDefines whether event schemas from other accounts are discovered. Default is True.
statestringDefines the current state of the discoverer.
tagsarrayTags associated with the resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the discoverer resource, the following permissions are required: + +### Read +
+schemas:DescribeDiscoverer
+ +### Update +
+schemas:DescribeDiscoverer,
+schemas:UpdateDiscoverer,
+schemas:TagResource,
+schemas:UntagResource,
+schemas:ListTagsForResource,
+events:PutTargets,
+events:PutRule
+ +### Delete +
+schemas:DescribeDiscoverer,
+schemas:DeleteDiscoverer,
+events:DeleteRule,
+events:DisableRule,
+events:RemoveTargets
+ + +## Example +```sql +SELECT +region, +discoverer_arn, +discoverer_id, +description, +source_arn, +cross_account, +state, +tags +FROM awscc.eventschemas.discoverer +WHERE region = 'us-east-1' +AND data__Identifier = '<DiscovererArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md b/docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md new file mode 100644 index 0000000000..0364a0aeab --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md @@ -0,0 +1,65 @@ +--- +title: discoverers +hide_title: false +hide_table_of_contents: false +keywords: + - discoverers + - 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 +--- +Retrieves a list of discoverers in a region + +## Overview + + + + + +
Namediscoverers
TypeResource
Descriptiondiscoverers
Idawscc.eventschemas.discoverers
+ +## Fields + + + + + +
NameDatatypeDescription
discoverer_arnstringThe ARN of the discoverer.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the discoverers resource, the following permissions are required: + +### Create +
+schemas:CreateDiscoverer,
+schemas:DescribeDiscoverer,
+schemas:TagResource,
+events:PutRule,
+events:PutTargets,
+events:EnableRule,
+events:ListTargetsByRule,
+iam:CreateServiceLinkedRole
+ +### List +
+schemas:ListDiscoverers
+ + +## Example +```sql +SELECT +region, +discoverer_arn +FROM awscc.eventschemas.discoverers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md b/docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md new file mode 100644 index 0000000000..b55afdb722 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md @@ -0,0 +1,74 @@ +--- +title: eventschemas_registry +hide_title: false +hide_table_of_contents: false +keywords: + - eventschemas_registry + - 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 +--- +Gets an individual eventschemas_registry resource + +## Overview + + + + + +
Nameeventschemas_registry
TypeResource
Descriptioneventschemas_registry
Idawscc.eventschemas.eventschemas_registry
+ +## Fields + + + + + + + + +
NameDatatypeDescription
registry_namestringThe name of the schema registry.
descriptionstringA description of the registry to be created.
registry_arnstringThe ARN of the registry.
tagsarrayTags associated with the resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the eventschemas_registry resource, the following permissions are required: + +### Read +
+schemas:DescribeRegistry
+ +### Update +
+schemas:DescribeRegistry,
+schemas:UpdateRegistry,
+schemas:TagResource,
+schemas:UntagResource,
+schemas:ListTagsForResource
+ +### Delete +
+schemas:DescribeRegistry,
+schemas:DeleteRegistry
+ + +## Example +```sql +SELECT +region, +registry_name, +description, +registry_arn, +tags +FROM awscc.eventschemas.eventschemas_registry +WHERE region = 'us-east-1' +AND data__Identifier = '<RegistryArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/index.md b/docs/awscc-docs/providers/awscc/eventschemas/index.md new file mode 100644 index 0000000000..b27d5083ed --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/index.md @@ -0,0 +1,45 @@ +--- +title: eventschemas +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The eventschemas service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+discoverer
+discoverers
+eventschemas_registry
+registries +
+
+registry_policies
+registry_policy
+schema
+schemata +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/eventschemas/registries/index.md b/docs/awscc-docs/providers/awscc/eventschemas/registries/index.md new file mode 100644 index 0000000000..2faad8d803 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/registries/index.md @@ -0,0 +1,60 @@ +--- +title: registries +hide_title: false +hide_table_of_contents: false +keywords: + - registries + - 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 +--- +Retrieves a list of registries in a region + +## Overview + + + + + +
Nameregistries
TypeResource
Descriptionregistries
Idawscc.eventschemas.registries
+ +## Fields + + + + + +
NameDatatypeDescription
registry_arnstringThe ARN of the registry.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the registries resource, the following permissions are required: + +### Create +
+schemas:DescribeRegistry,
+schemas:CreateRegistry,
+schemas:TagResource
+ +### List +
+schemas:ListRegistries
+ + +## Example +```sql +SELECT +region, +registry_arn +FROM awscc.eventschemas.registries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/registry_policies/index.md b/docs/awscc-docs/providers/awscc/eventschemas/registry_policies/index.md new file mode 100644 index 0000000000..add829c432 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/registry_policies/index.md @@ -0,0 +1,56 @@ +--- +title: registry_policies +hide_title: false +hide_table_of_contents: false +keywords: + - registry_policies + - 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 +--- +Retrieves a list of registry_policies in a region + +## Overview + + + + + +
Nameregistry_policies
TypeResource
Descriptionregistry_policies
Idawscc.eventschemas.registry_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the registry_policies resource, the following permissions are required: + +### Create +
+schemas:PutResourcePolicy,
+schemas:GetResourcePolicy,
+schemas:DescribeRegistry
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.eventschemas.registry_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md b/docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md new file mode 100644 index 0000000000..48d5d40192 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md @@ -0,0 +1,71 @@ +--- +title: registry_policy +hide_title: false +hide_table_of_contents: false +keywords: + - registry_policy + - 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 +--- +Gets an individual registry_policy resource + +## Overview + + + + + +
Nameregistry_policy
TypeResource
Descriptionregistry_policy
Idawscc.eventschemas.registry_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
policyobject
registry_namestring
revision_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the registry_policy resource, the following permissions are required: + +### Delete +
+schemas:DeleteResourcePolicy,
+schemas:GetResourcePolicy
+ +### Update +
+schemas:PutResourcePolicy,
+schemas:GetResourcePolicy
+ +### Read +
+schemas:GetResourcePolicy
+ + +## Example +```sql +SELECT +region, +id, +policy, +registry_name, +revision_id +FROM awscc.eventschemas.registry_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/schema/index.md b/docs/awscc-docs/providers/awscc/eventschemas/schema/index.md new file mode 100644 index 0000000000..4b42f04b9d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/schema/index.md @@ -0,0 +1,87 @@ +--- +title: schema +hide_title: false +hide_table_of_contents: false +keywords: + - schema + - 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 +--- +Gets an individual schema resource + +## Overview + + + + + +
Nameschema
TypeResource
Descriptionschema
Idawscc.eventschemas.schema
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
typestringThe type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
descriptionstringA description of the schema.
schema_versionstringThe version number of the schema.
contentstringThe source of the schema definition.
registry_namestringThe name of the schema registry.
schema_arnstringThe ARN of the schema.
schema_namestringThe name of the schema.
last_modifiedstringThe last modified time of the schema.
version_created_datestringThe date the schema version was created.
tagsarrayTags associated with the resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schema resource, the following permissions are required: + +### Read +
+schemas:DescribeSchema
+ +### Update +
+schemas:DescribeSchema,
+schemas:UpdateSchema,
+schemas:TagResource,
+schemas:UntagResource,
+schemas:ListTagsForResource
+ +### Delete +
+schemas:DescribeSchema,
+schemas:DeleteSchema,
+schemas:DeleteSchemaVersion
+ + +## Example +```sql +SELECT +region, +type, +description, +schema_version, +content, +registry_name, +schema_arn, +schema_name, +last_modified, +version_created_date, +tags +FROM awscc.eventschemas.schema +WHERE region = 'us-east-1' +AND data__Identifier = '<SchemaArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md b/docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md new file mode 100644 index 0000000000..d00101cbee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md @@ -0,0 +1,61 @@ +--- +title: schemata +hide_title: false +hide_table_of_contents: false +keywords: + - schemata + - 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 +--- +Retrieves a list of schemata in a region + +## Overview + + + + + +
Nameschemata
TypeResource
Descriptionschemata
Idawscc.eventschemas.schemata
+ +## Fields + + + + + +
NameDatatypeDescription
schema_arnstringThe ARN of the schema.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schemata resource, the following permissions are required: + +### Create +
+schemas:DescribeSchema,
+schemas:CreateSchema,
+schemas:TagResource
+ +### List +
+schemas:ListSchemas,
+schemas:ListSchemaVersions
+ + +## Example +```sql +SELECT +region, +schema_arn +FROM awscc.eventschemas.schemata +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/experiment/index.md b/docs/awscc-docs/providers/awscc/evidently/experiment/index.md new file mode 100644 index 0000000000..45ef73b359 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/experiment/index.md @@ -0,0 +1,95 @@ +--- +title: experiment +hide_title: false +hide_table_of_contents: false +keywords: + - experiment + - 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 +--- +Gets an individual experiment resource + +## Overview + + + + + +
Nameexperiment
TypeResource
Descriptionexperiment
Idawscc.evidently.experiment
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
projectstring
descriptionstring
running_statusobjectStart Experiment. Default is False
randomization_saltstring
treatmentsarray
metric_goalsarray
sampling_rateinteger
online_ab_configobject
segmentstring
remove_segmentboolean
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the experiment resource, the following permissions are required: + +### Read +
+evidently:GetExperiment,
+evidently:ListTagsForResource
+ +### Update +
+evidently:UpdateExperiment,
+evidently:TagResource,
+evidently:UntagResource,
+evidently:GetExperiment,
+evidently:StartExperiment,
+evidently:StopExperiment
+ +### Delete +
+evidently:DeleteExperiment,
+evidently:UntagResource,
+evidently:GetExperiment
+ + +## Example +```sql +SELECT +region, +arn, +name, +project, +description, +running_status, +randomization_salt, +treatments, +metric_goals, +sampling_rate, +online_ab_config, +segment, +remove_segment, +tags +FROM awscc.evidently.experiment +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/experiments/index.md b/docs/awscc-docs/providers/awscc/evidently/experiments/index.md new file mode 100644 index 0000000000..c283e4ad2e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/experiments/index.md @@ -0,0 +1,57 @@ +--- +title: experiments +hide_title: false +hide_table_of_contents: false +keywords: + - experiments + - 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 +--- +Retrieves a list of experiments in a region + +## Overview + + + + + +
Nameexperiments
TypeResource
Descriptionexperiments
Idawscc.evidently.experiments
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the experiments resource, the following permissions are required: + +### Create +
+evidently:CreateExperiment,
+evidently:TagResource,
+evidently:GetExperiment,
+evidently:StartExperiment
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.evidently.experiments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/feature/index.md b/docs/awscc-docs/providers/awscc/evidently/feature/index.md new file mode 100644 index 0000000000..a3550e4e94 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/feature/index.md @@ -0,0 +1,86 @@ +--- +title: feature +hide_title: false +hide_table_of_contents: false +keywords: + - feature + - 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 +--- +Gets an individual feature resource + +## Overview + + + + + +
Namefeature
TypeResource
Descriptionfeature
Idawscc.evidently.feature
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
projectstring
namestring
descriptionstring
evaluation_strategystring
variationsarray
default_variationstring
entity_overridesarray
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the feature resource, the following permissions are required: + +### Read +
+evidently:GetFeature,
+evidently:ListTagsForResource
+ +### Update +
+evidently:UpdateFeature,
+evidently:ListTagsForResource,
+evidently:TagResource,
+evidently:UntagResource,
+evidently:GetFeature
+ +### Delete +
+evidently:DeleteFeature,
+evidently:UntagResource,
+evidently:GetFeature
+ + +## Example +```sql +SELECT +region, +arn, +project, +name, +description, +evaluation_strategy, +variations, +default_variation, +entity_overrides, +tags +FROM awscc.evidently.feature +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/features/index.md b/docs/awscc-docs/providers/awscc/evidently/features/index.md new file mode 100644 index 0000000000..818e030162 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/features/index.md @@ -0,0 +1,56 @@ +--- +title: features +hide_title: false +hide_table_of_contents: false +keywords: + - features + - 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 +--- +Retrieves a list of features in a region + +## Overview + + + + + +
Namefeatures
TypeResource
Descriptionfeatures
Idawscc.evidently.features
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the features resource, the following permissions are required: + +### Create +
+evidently:CreateFeature,
+evidently:TagResource,
+evidently:GetFeature
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.evidently.features +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/index.md b/docs/awscc-docs/providers/awscc/evidently/index.md new file mode 100644 index 0000000000..0e2432264a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/index.md @@ -0,0 +1,47 @@ +--- +title: evidently +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The evidently service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+experiment
+experiments
+feature
+features
+launch +
+
+launches
+project
+projects
+segment
+segments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/evidently/launch/index.md b/docs/awscc-docs/providers/awscc/evidently/launch/index.md new file mode 100644 index 0000000000..20b310d782 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/launch/index.md @@ -0,0 +1,90 @@ +--- +title: launch +hide_title: false +hide_table_of_contents: false +keywords: + - launch + - 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 +--- +Gets an individual launch resource + +## Overview + + + + + +
Namelaunch
TypeResource
Descriptionlaunch
Idawscc.evidently.launch
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
projectstring
descriptionstring
randomization_saltstring
scheduled_splits_configarray
groupsarray
metric_monitorsarray
tagsarrayAn array of key-value pairs to apply to this resource.
execution_statusobjectStart or Stop Launch Launch. Default is not started.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the launch resource, the following permissions are required: + +### Read +
+evidently:GetLaunch,
+evidently:ListTagsForResource
+ +### Update +
+evidently:UpdateLaunch,
+evidently:ListTagsForResource,
+evidently:TagResource,
+evidently:UntagResource,
+evidently:GetLaunch,
+evidently:StartLaunch,
+evidently:StopLaunch
+ +### Delete +
+evidently:DeleteLaunch,
+evidently:UntagResource,
+evidently:GetLaunch
+ + +## Example +```sql +SELECT +region, +arn, +name, +project, +description, +randomization_salt, +scheduled_splits_config, +groups, +metric_monitors, +tags, +execution_status +FROM awscc.evidently.launch +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/launches/index.md b/docs/awscc-docs/providers/awscc/evidently/launches/index.md new file mode 100644 index 0000000000..ae9db6e26c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/launches/index.md @@ -0,0 +1,57 @@ +--- +title: launches +hide_title: false +hide_table_of_contents: false +keywords: + - launches + - 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 +--- +Retrieves a list of launches in a region + +## Overview + + + + + +
Namelaunches
TypeResource
Descriptionlaunches
Idawscc.evidently.launches
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the launches resource, the following permissions are required: + +### Create +
+evidently:CreateLaunch,
+evidently:TagResource,
+evidently:GetLaunch,
+evidently:StartLaunch
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.evidently.launches +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/project/index.md b/docs/awscc-docs/providers/awscc/evidently/project/index.md new file mode 100644 index 0000000000..2aa4ffbc0a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/project/index.md @@ -0,0 +1,112 @@ +--- +title: project +hide_title: false +hide_table_of_contents: false +keywords: + - project + - 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 +--- +Gets an individual project resource + +## Overview + + + + + +
Nameproject
TypeResource
Descriptionproject
Idawscc.evidently.project
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
descriptionstring
data_deliveryobject
app_config_resourceobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +
+evidently:GetProject,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+s3:GetBucketPolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+evidently:ListTagsForResource
+ +### Update +
+evidently:UpdateProject,
+evidently:UpdateProjectDataDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:ListLogDeliveries,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+evidently:TagResource,
+evidently:UntagResource,
+evidently:ListTagsForResource,
+evidently:GetProject,
+evidently:ExportProjectAsConfiguration,
+appconfig:GetEnvironment,
+appconfig:CreateConfigurationProfile,
+appconfig:CreateHostedConfigurationVersion,
+appconfig:CreateExtensionAssociation,
+appconfig:TagResource,
+iam:GetRole,
+iam:CreateServiceLinkedRole
+ +### Delete +
+evidently:DeleteProject,
+evidently:GetProject,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+s3:GetBucketPolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+evidently:UntagResource,
+appconfig:DeleteHostedConfigurationVersion,
+appconfig:DeleteExtensionAssociation,
+appconfig:DeleteConfigurationProfile
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +data_delivery, +app_config_resource, +tags +FROM awscc.evidently.project +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/projects/index.md b/docs/awscc-docs/providers/awscc/evidently/projects/index.md new file mode 100644 index 0000000000..762aa7c04e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/projects/index.md @@ -0,0 +1,69 @@ +--- +title: projects +hide_title: false +hide_table_of_contents: false +keywords: + - projects + - 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 +--- +Retrieves a list of projects in a region + +## Overview + + + + + +
Nameprojects
TypeResource
Descriptionprojects
Idawscc.evidently.projects
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +
+evidently:CreateProject,
+evidently:GetProject,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+evidently:TagResource,
+evidently:ExportProjectAsConfiguration,
+appconfig:GetEnvironment,
+appconfig:CreateConfigurationProfile,
+appconfig:CreateHostedConfigurationVersion,
+appconfig:CreateExtensionAssociation,
+appconfig:TagResource,
+iam:GetRole,
+iam:CreateServiceLinkedRole
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.evidently.projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/segment/index.md b/docs/awscc-docs/providers/awscc/evidently/segment/index.md new file mode 100644 index 0000000000..f217118814 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/segment/index.md @@ -0,0 +1,70 @@ +--- +title: segment +hide_title: false +hide_table_of_contents: false +keywords: + - segment + - 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 +--- +Gets an individual segment resource + +## Overview + + + + + +
Namesegment
TypeResource
Descriptionsegment
Idawscc.evidently.segment
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
descriptionstring
patternstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the segment resource, the following permissions are required: + +### Read +
+evidently:GetSegment,
+evidently:ListTagsForResource
+ +### Delete +
+evidently:DeleteSegment,
+evidently:GetSegment,
+evidently:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +pattern, +tags +FROM awscc.evidently.segment +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/evidently/segments/index.md b/docs/awscc-docs/providers/awscc/evidently/segments/index.md new file mode 100644 index 0000000000..4beb03933b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/evidently/segments/index.md @@ -0,0 +1,61 @@ +--- +title: segments +hide_title: false +hide_table_of_contents: false +keywords: + - segments + - 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 +--- +Retrieves a list of segments in a region + +## Overview + + + + + +
Namesegments
TypeResource
Descriptionsegments
Idawscc.evidently.segments
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the segments resource, the following permissions are required: + +### Create +
+evidently:CreateSegment,
+evidently:GetSegment,
+evidently:TagResource
+ +### List +
+evidently:ListSegment,
+evidently:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.evidently.segments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/finspace/environment/index.md b/docs/awscc-docs/providers/awscc/finspace/environment/index.md new file mode 100644 index 0000000000..5456944d74 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/finspace/environment/index.md @@ -0,0 +1,92 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.finspace.environment
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
environment_idstringUnique identifier for representing FinSpace Environment
namestringName of the Environment
aws_account_idstringAWS account ID associated with the Environment
descriptionstringDescription of the Environment
statusstringState of the Environment
environment_urlstringURL used to login to the Environment
environment_arnstringARN of the Environment
sage_maker_studio_domain_urlstringSageMaker Studio Domain URL associated with the Environment
kms_key_idstringKMS key used to encrypt customer data within FinSpace Environment infrastructure
dedicated_service_account_idstringID for FinSpace created account used to store Environment artifacts
federation_modestringFederation mode used with the Environment
federation_parametersobject
superuser_parametersobject
data_bundlesarrayARNs of FinSpace Data Bundles to install
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+finspace:GetEnvironment
+ +### Update +
+finspace:UpdateEnvironment
+ +### Delete +
+finspace:DeleteEnvironment,
+finspace:GetEnvironment
+ + +## Example +```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, +tags +FROM awscc.finspace.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<EnvironmentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/finspace/environments/index.md b/docs/awscc-docs/providers/awscc/finspace/environments/index.md new file mode 100644 index 0000000000..5a8b972953 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/finspace/environments/index.md @@ -0,0 +1,61 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.finspace.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_idstringUnique identifier for representing FinSpace Environment
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+finspace:CreateEnvironment,
+finspace:GetEnvironment,
+finspace:ListEnvironments,
+sts:AssumeRole
+ +### List +
+finspace:ListEnvironments
+ + +## Example +```sql +SELECT +region, +environment_id +FROM awscc.finspace.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/finspace/index.md b/docs/awscc-docs/providers/awscc/finspace/index.md new file mode 100644 index 0000000000..bfa819c62a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/finspace/index.md @@ -0,0 +1,39 @@ +--- +title: finspace +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The finspace service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+environment +
+
+environments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/fis/experiment_template/index.md b/docs/awscc-docs/providers/awscc/fis/experiment_template/index.md new file mode 100644 index 0000000000..754821a00b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fis/experiment_template/index.md @@ -0,0 +1,83 @@ +--- +title: experiment_template +hide_title: false +hide_table_of_contents: false +keywords: + - experiment_template + - 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 +--- +Gets an individual experiment_template resource + +## Overview + + + + + +
Nameexperiment_template
TypeResource
Descriptionexperiment_template
Idawscc.fis.experiment_template
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
descriptionstring
targetsobject
actionsobject
stop_conditionsarray
log_configurationobject
role_arnstring
tagsobject
experiment_optionsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the experiment_template resource, the following permissions are required: + +### Read +
+fis:GetExperimentTemplate,
+fis:ListTagsForResource
+ +### Update +
+fis:UpdateExperimentTemplate,
+fis:TagResource,
+fis:UntagResource,
+iam:PassRole
+ +### Delete +
+fis:DeleteExperimentTemplate
+ + +## Example +```sql +SELECT +region, +id, +description, +targets, +actions, +stop_conditions, +log_configuration, +role_arn, +tags, +experiment_options +FROM awscc.fis.experiment_template +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md b/docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md new file mode 100644 index 0000000000..22fc840657 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md @@ -0,0 +1,61 @@ +--- +title: experiment_templates +hide_title: false +hide_table_of_contents: false +keywords: + - experiment_templates + - 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 +--- +Retrieves a list of experiment_templates in a region + +## Overview + + + + + +
Nameexperiment_templates
TypeResource
Descriptionexperiment_templates
Idawscc.fis.experiment_templates
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the experiment_templates resource, the following permissions are required: + +### Create +
+fis:CreateExperimentTemplate,
+fis:TagResource,
+iam:PassRole
+ +### List +
+fis:ListExperimentTemplates,
+fis:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.fis.experiment_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/fis/index.md b/docs/awscc-docs/providers/awscc/fis/index.md new file mode 100644 index 0000000000..9602738aae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fis/index.md @@ -0,0 +1,41 @@ +--- +title: fis +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The fis service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+experiment_template
+experiment_templates +
+
+target_account_configuration
+target_account_configurations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/fis/target_account_configuration/index.md b/docs/awscc-docs/providers/awscc/fis/target_account_configuration/index.md new file mode 100644 index 0000000000..e274fa6dff --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fis/target_account_configuration/index.md @@ -0,0 +1,70 @@ +--- +title: target_account_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - target_account_configuration + - 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 +--- +Gets an individual target_account_configuration resource + +## Overview + + + + + +
Nametarget_account_configuration
TypeResource
Descriptiontarget_account_configuration
Idawscc.fis.target_account_configuration
+ +## Fields + + + + + + + + +
NameDatatypeDescription
experiment_template_idstring
account_idstring
role_arnstring
descriptionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the target_account_configuration resource, the following permissions are required: + +### Read +
+fis:GetTargetAccountConfiguration
+ +### Update +
+fis:UpdateTargetAccountConfiguration
+ +### Delete +
+fis:DeleteTargetAccountConfiguration
+ + +## Example +```sql +SELECT +region, +experiment_template_id, +account_id, +role_arn, +description +FROM awscc.fis.target_account_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<ExperimentTemplateId>' +AND data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/fis/target_account_configurations/index.md b/docs/awscc-docs/providers/awscc/fis/target_account_configurations/index.md new file mode 100644 index 0000000000..63559039f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fis/target_account_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: target_account_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - target_account_configurations + - 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 +--- +Retrieves a list of target_account_configurations in a region + +## Overview + + + + + +
Nametarget_account_configurations
TypeResource
Descriptiontarget_account_configurations
Idawscc.fis.target_account_configurations
+ +## Fields + + + + + + +
NameDatatypeDescription
experiment_template_idundefined
account_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the target_account_configurations resource, the following permissions are required: + +### Create +
+fis:CreateTargetAccountConfiguration
+ +### List +
+fis:ListTargetAccountConfigurations
+ + +## Example +```sql +SELECT +region, +experiment_template_id, +account_id +FROM awscc.fis.target_account_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/fms/index.md b/docs/awscc-docs/providers/awscc/fms/index.md new file mode 100644 index 0000000000..a434d7910a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fms/index.md @@ -0,0 +1,43 @@ +--- +title: fms +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The fms service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+notification_channel
+notification_channels
+policies +
+
+policy
+resource_set
+resource_sets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/fms/notification_channel/index.md b/docs/awscc-docs/providers/awscc/fms/notification_channel/index.md new file mode 100644 index 0000000000..b1b5be5673 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fms/notification_channel/index.md @@ -0,0 +1,66 @@ +--- +title: notification_channel +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channel + - 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 +--- +Gets an individual notification_channel resource + +## Overview + + + + + +
Namenotification_channel
TypeResource
Descriptionnotification_channel
Idawscc.fms.notification_channel
+ +## Fields + + + + + + +
NameDatatypeDescription
sns_role_namestring
sns_topic_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the notification_channel resource, the following permissions are required: + +### Update +
+fms:PutNotificationChannel,
+iam:PassRole
+ +### Read +
+fms:GetNotificationChannel
+ +### Delete +
+fms:DeleteNotificationChannel
+ + +## Example +```sql +SELECT +region, +sns_role_name, +sns_topic_arn +FROM awscc.fms.notification_channel +WHERE region = 'us-east-1' +AND data__Identifier = '<SnsTopicArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/fms/notification_channels/index.md b/docs/awscc-docs/providers/awscc/fms/notification_channels/index.md new file mode 100644 index 0000000000..e3fa2f66c7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fms/notification_channels/index.md @@ -0,0 +1,59 @@ +--- +title: notification_channels +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channels + - 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 +--- +Retrieves a list of notification_channels in a region + +## Overview + + + + + +
Namenotification_channels
TypeResource
Descriptionnotification_channels
Idawscc.fms.notification_channels
+ +## Fields + + + + + +
NameDatatypeDescription
sns_topic_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the notification_channels resource, the following permissions are required: + +### Create +
+fms:PutNotificationChannel,
+iam:PassRole
+ +### List +
+fms:GetNotificationChannel
+ + +## Example +```sql +SELECT +region, +sns_topic_arn +FROM awscc.fms.notification_channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/fms/policies/index.md b/docs/awscc-docs/providers/awscc/fms/policies/index.md new file mode 100644 index 0000000000..c7d27a5094 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fms/policies/index.md @@ -0,0 +1,71 @@ +--- +title: policies +hide_title: false +hide_table_of_contents: false +keywords: + - policies + - 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 +--- +Retrieves a list of policies in a region + +## Overview + + + + + +
Namepolicies
TypeResource
Descriptionpolicies
Idawscc.fms.policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +
+fms:PutPolicy,
+fms:TagResource,
+waf-regional:ListRuleGroups,
+wafv2:CheckCapacity,
+wafv2:ListRuleGroups,
+wafv2:ListAvailableManagedRuleGroups,
+wafv2:ListAvailableManagedRuleGroupVersions,
+network-firewall:DescribeRuleGroup,
+network-firewall:DescribeRuleGroupMetadata,
+route53resolver:ListFirewallRuleGroups,
+ec2:DescribeAvailabilityZones,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy
+ +### List +
+fms:ListPolicies,
+fms:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.fms.policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/fms/policy/index.md b/docs/awscc-docs/providers/awscc/fms/policy/index.md new file mode 100644 index 0000000000..edc846a4e5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fms/policy/index.md @@ -0,0 +1,109 @@ +--- +title: policy +hide_title: false +hide_table_of_contents: false +keywords: + - policy + - 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 +--- +Gets an individual policy resource + +## Overview + + + + + +
Namepolicy
TypeResource
Descriptionpolicy
Idawscc.fms.policy
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
exclude_mapobject
exclude_resource_tagsboolean
include_mapobject
idstring
policy_namestring
policy_descriptionstring
remediation_enabledboolean
resource_tagsarray
resource_typestring
resource_type_listarray
resource_set_idsarray
security_service_policy_dataobject
arnstring
delete_all_policy_resourcesboolean
resources_clean_upboolean
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Update +
+fms:PutPolicy,
+fms:GetPolicy,
+fms:TagResource,
+fms:UntagResource,
+fms:ListTagsForResource,
+waf-regional:ListRuleGroups,
+wafv2:CheckCapacity,
+wafv2:ListRuleGroups,
+wafv2:ListAvailableManagedRuleGroups,
+wafv2:ListAvailableManagedRuleGroupVersions,
+network-firewall:DescribeRuleGroup,
+network-firewall:DescribeRuleGroupMetadata,
+route53resolver:ListFirewallRuleGroups,
+ec2:DescribeAvailabilityZones,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy
+ +### Read +
+fms:GetPolicy,
+fms:ListTagsForResource
+ +### Delete +
+fms:DeletePolicy
+ + +## Example +```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, +tags +FROM awscc.fms.policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/fms/resource_set/index.md b/docs/awscc-docs/providers/awscc/fms/resource_set/index.md new file mode 100644 index 0000000000..94ace1d7d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fms/resource_set/index.md @@ -0,0 +1,82 @@ +--- +title: resource_set +hide_title: false +hide_table_of_contents: false +keywords: + - resource_set + - 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 +--- +Gets an individual resource_set resource + +## Overview + + + + + +
Nameresource_set
TypeResource
Descriptionresource_set
Idawscc.fms.resource_set
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
namestring
descriptionstring
resource_type_listarray
resourcesarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_set resource, the following permissions are required: + +### Update +
+fms:PutResourceSet,
+fms:BatchAssociateResource,
+fms:BatchDisassociateResource,
+fms:GetResourceSet,
+fms:ListResourceSetResources,
+fms:TagResource,
+fms:UntagResource,
+fms:ListTagsForResource
+ +### Read +
+fms:GetResourceSet,
+fms:ListResourceSetResources,
+fms:ListTagsForResource
+ +### Delete +
+fms:DeleteResourceSet
+ + +## Example +```sql +SELECT +region, +id, +name, +description, +resource_type_list, +resources, +tags +FROM awscc.fms.resource_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/fms/resource_sets/index.md b/docs/awscc-docs/providers/awscc/fms/resource_sets/index.md new file mode 100644 index 0000000000..a6a61c84df --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fms/resource_sets/index.md @@ -0,0 +1,61 @@ +--- +title: resource_sets +hide_title: false +hide_table_of_contents: false +keywords: + - resource_sets + - 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 +--- +Retrieves a list of resource_sets in a region + +## Overview + + + + + +
Nameresource_sets
TypeResource
Descriptionresource_sets
Idawscc.fms.resource_sets
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_sets resource, the following permissions are required: + +### Create +
+fms:PutResourceSet,
+fms:BatchAssociateResource,
+fms:ListResourceSetResources,
+fms:TagResource
+ +### List +
+fms:ListResourceSets
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.fms.resource_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/forecast/dataset/index.md b/docs/awscc-docs/providers/awscc/forecast/dataset/index.md new file mode 100644 index 0000000000..2a2b6e8eec --- /dev/null +++ b/docs/awscc-docs/providers/awscc/forecast/dataset/index.md @@ -0,0 +1,73 @@ +--- +title: dataset +hide_title: false +hide_table_of_contents: false +keywords: + - dataset + - 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 +--- +Gets an individual dataset resource + +## Overview + + + + + +
Namedataset
TypeResource
Descriptiondataset
Idawscc.forecast.dataset
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
dataset_namestringA name for the dataset
dataset_typestringThe dataset type
data_frequencystringFrequency of data collection. This parameter is required for RELATED_TIME_SERIES
domainstringThe domain associated with the dataset
encryption_configobject
schemaobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +
+forecast:DescribeDataset
+ +### Delete +
+forecast:DeleteDataset
+ + +## Example +```sql +SELECT +region, +arn, +dataset_name, +dataset_type, +data_frequency, +domain, +encryption_config, +schema, +tags +FROM awscc.forecast.dataset +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md b/docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md new file mode 100644 index 0000000000..ff4f070fb9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md @@ -0,0 +1,71 @@ +--- +title: dataset_group +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_group + - 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 +--- +Gets an individual dataset_group resource + +## Overview + + + + + +
Namedataset_group
TypeResource
Descriptiondataset_group
Idawscc.forecast.dataset_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
dataset_arnsarrayAn array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
dataset_group_namestringA name for the dataset group.
domainstringThe 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.
tagsarrayThe tags of Application Insights application.
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group to delete.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset_group resource, the following permissions are required: + +### Read +
+forecast:DescribeDatasetGroup
+ +### Update +
+forecast:UpdateDatasetGroup
+ +### Delete +
+forecast:DeleteDatasetGroup
+ + +## Example +```sql +SELECT +region, +dataset_arns, +dataset_group_name, +domain, +tags, +dataset_group_arn +FROM awscc.forecast.dataset_group +WHERE region = 'us-east-1' +AND data__Identifier = '<DatasetGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md b/docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md new file mode 100644 index 0000000000..8530bf16f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md @@ -0,0 +1,58 @@ +--- +title: dataset_groups +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_groups + - 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 +--- +Retrieves a list of dataset_groups in a region + +## Overview + + + + + +
Namedataset_groups
TypeResource
Descriptiondataset_groups
Idawscc.forecast.dataset_groups
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group to delete.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset_groups resource, the following permissions are required: + +### Create +
+forecast:CreateDatasetGroup
+ +### List +
+forecast:ListDatasetGroups
+ + +## Example +```sql +SELECT +region, +dataset_group_arn +FROM awscc.forecast.dataset_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/forecast/datasets/index.md b/docs/awscc-docs/providers/awscc/forecast/datasets/index.md new file mode 100644 index 0000000000..44e1d4b89f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/forecast/datasets/index.md @@ -0,0 +1,58 @@ +--- +title: datasets +hide_title: false +hide_table_of_contents: false +keywords: + - datasets + - 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 +--- +Retrieves a list of datasets in a region + +## Overview + + + + + +
Namedatasets
TypeResource
Descriptiondatasets
Idawscc.forecast.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +
+forecast:CreateDataset
+ +### List +
+forecast:ListDatasets
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.forecast.datasets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/forecast/index.md b/docs/awscc-docs/providers/awscc/forecast/index.md new file mode 100644 index 0000000000..d17de39e23 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/forecast/index.md @@ -0,0 +1,41 @@ +--- +title: forecast +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The forecast service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+dataset
+dataset_group +
+
+dataset_groups
+datasets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/frauddetector/detector/index.md b/docs/awscc-docs/providers/awscc/frauddetector/detector/index.md new file mode 100644 index 0000000000..a0d874b02b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/detector/index.md @@ -0,0 +1,142 @@ +--- +title: detector +hide_title: false +hide_table_of_contents: false +keywords: + - detector + - 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 +--- +Gets an individual detector resource + +## Overview + + + + + +
Namedetector
TypeResource
Descriptiondetector
Idawscc.frauddetector.detector
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
detector_idstringThe ID of the detector
detector_version_statusstringThe desired detector version status for the detector
detector_version_idstringThe active version ID of the detector
rule_execution_modestring
tagsarrayTags associated with this detector.
descriptionstringThe description of the detector.
rulesarray
event_typeobjectThe event type to associate this detector with.
arnstringThe ARN of the detector.
created_timestringThe time when the detector was created.
last_updated_timestringThe time when the detector was last updated.
associated_modelsarrayThe models to associate with this detector.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the detector resource, the following permissions are required: + +### Update +
+frauddetector:GetDetectors,
+frauddetector:GetDetectorVersion,
+frauddetector:PutDetector,
+frauddetector:UpdateDetectorVersion,
+frauddetector:UpdateDetectorVersionStatus,
+frauddetector:UpdateDetectorVersionMetadata,
+frauddetector:UpdateRuleVersion,
+frauddetector:UpdateRuleMetadata,
+frauddetector:CreateRule,
+frauddetector:CreateVariable,
+frauddetector:UpdateVariable,
+frauddetector:GetVariables,
+frauddetector:PutLabel,
+frauddetector:PutOutcome,
+frauddetector:PutEntityType,
+frauddetector:PutEventType,
+frauddetector:GetRules,
+frauddetector:GetEventTypes,
+frauddetector:GetLabels,
+frauddetector:GetOutcomes,
+frauddetector:GetEntityTypes,
+frauddetector:GetExternalModels,
+frauddetector:GetModelVersion,
+frauddetector:DeleteEventType,
+frauddetector:DeleteVariable,
+frauddetector:DeleteLabel,
+frauddetector:DeleteEntityType,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource,
+frauddetector:UntagResource
+ +### Delete +
+frauddetector:GetDetectors,
+frauddetector:GetDetectorVersion,
+frauddetector:DescribeDetector,
+frauddetector:GetRules,
+frauddetector:GetVariables,
+frauddetector:GetEventTypes,
+frauddetector:GetLabels,
+frauddetector:GetOutcomes,
+frauddetector:GetEntityTypes,
+frauddetector:DeleteDetector,
+frauddetector:DeleteDetectorVersion,
+frauddetector:DeleteRule,
+frauddetector:DeleteEventType,
+frauddetector:DeleteVariable,
+frauddetector:DeleteLabel,
+frauddetector:DeleteOutcome,
+frauddetector:DeleteEntityType,
+frauddetector:ListTagsForResource
+ +### Read +
+frauddetector:GetDetectors,
+frauddetector:GetDetectorVersion,
+frauddetector:DescribeDetector,
+frauddetector:GetRules,
+frauddetector:GetVariables,
+frauddetector:GetEventTypes,
+frauddetector:GetExternalModels,
+frauddetector:GetModelVersion,
+frauddetector:GetLabels,
+frauddetector:GetOutcomes,
+frauddetector:GetEntityTypes,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +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 awscc.frauddetector.detector +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md b/docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md new file mode 100644 index 0000000000..10cbd6f752 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md @@ -0,0 +1,89 @@ +--- +title: detectors +hide_title: false +hide_table_of_contents: false +keywords: + - detectors + - 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 +--- +Retrieves a list of detectors in a region + +## Overview + + + + + +
Namedetectors
TypeResource
Descriptiondetectors
Idawscc.frauddetector.detectors
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the detector.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the detectors resource, the following permissions are required: + +### Create +
+frauddetector:PutDetector,
+frauddetector:CreateDetectorVersion,
+frauddetector:UpdateDetectorVersionStatus,
+frauddetector:CreateRule,
+frauddetector:CreateVariable,
+frauddetector:PutLabel,
+frauddetector:PutOutcome,
+frauddetector:PutEntityType,
+frauddetector:PutEventType,
+frauddetector:DescribeDetector,
+frauddetector:GetDetectors,
+frauddetector:GetDetectorVersion,
+frauddetector:GetRules,
+frauddetector:GetVariables,
+frauddetector:GetEventTypes,
+frauddetector:GetExternalModels,
+frauddetector:GetModelVersion,
+frauddetector:GetLabels,
+frauddetector:GetOutcomes,
+frauddetector:GetEntityTypes,
+frauddetector:ListTagsForResource
+ +### List +
+frauddetector:GetDetectors,
+frauddetector:GetDetectorVersion,
+frauddetector:DescribeDetector,
+frauddetector:GetRules,
+frauddetector:GetVariables,
+frauddetector:GetEventTypes,
+frauddetector:GetExternalModels,
+frauddetector:GetModelVersion,
+frauddetector:GetLabels,
+frauddetector:GetOutcomes,
+frauddetector:GetEntityTypes,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.frauddetector.detectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md b/docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md new file mode 100644 index 0000000000..55d34880a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md @@ -0,0 +1,110 @@ +--- +title: event_type +hide_title: false +hide_table_of_contents: false +keywords: + - event_type + - 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 +--- +Gets an individual event_type resource + +## Overview + + + + + +
Nameevent_type
TypeResource
Descriptionevent_type
Idawscc.frauddetector.event_type
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name for the event type
tagsarrayTags associated with this event type.
descriptionstringThe description of the event type.
event_variablesarray
labelsarray
entity_typesarray
arnstringThe ARN of the event type.
created_timestringThe time when the event type was created.
last_updated_timestringThe time when the event type was last updated.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_type resource, the following permissions are required: + +### Update +
+frauddetector:BatchCreateVariable,
+frauddetector:BatchGetVariable,
+frauddetector:CreateVariable,
+frauddetector:UpdateVariable,
+frauddetector:GetVariables,
+frauddetector:PutLabel,
+frauddetector:PutEntityType,
+frauddetector:PutEventType,
+frauddetector:GetEventTypes,
+frauddetector:GetLabels,
+frauddetector:GetEntityTypes,
+frauddetector:DeleteEventType,
+frauddetector:DeleteVariable,
+frauddetector:DeleteLabel,
+frauddetector:DeleteEntityType,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource,
+frauddetector:UntagResource
+ +### Delete +
+frauddetector:BatchGetVariable,
+frauddetector:GetVariables,
+frauddetector:GetEventTypes,
+frauddetector:GetLabels,
+frauddetector:GetEntityTypes,
+frauddetector:DeleteEventType,
+frauddetector:DeleteVariable,
+frauddetector:DeleteLabel,
+frauddetector:DeleteEntityType,
+frauddetector:ListTagsForResource
+ +### Read +
+frauddetector:BatchGetVariable,
+frauddetector:GetVariables,
+frauddetector:GetEventTypes,
+frauddetector:GetLabels,
+frauddetector:GetEntityTypes,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +name, +tags, +description, +event_variables, +labels, +entity_types, +arn, +created_time, +last_updated_time +FROM awscc.frauddetector.event_type +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md b/docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md new file mode 100644 index 0000000000..03793c8c5a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md @@ -0,0 +1,74 @@ +--- +title: event_types +hide_title: false +hide_table_of_contents: false +keywords: + - event_types + - 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 +--- +Retrieves a list of event_types in a region + +## Overview + + + + + +
Nameevent_types
TypeResource
Descriptionevent_types
Idawscc.frauddetector.event_types
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the event type.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_types resource, the following permissions are required: + +### Create +
+frauddetector:BatchCreateVariable,
+frauddetector:BatchGetVariable,
+frauddetector:CreateVariable,
+frauddetector:GetVariables,
+frauddetector:PutLabel,
+frauddetector:PutEntityType,
+frauddetector:PutEventType,
+frauddetector:GetEventTypes,
+frauddetector:GetLabels,
+frauddetector:GetEntityTypes,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource
+ +### List +
+frauddetector:BatchGetVariable,
+frauddetector:GetVariables,
+frauddetector:GetEventTypes,
+frauddetector:GetLabels,
+frauddetector:GetEntityTypes,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.frauddetector.event_types +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md b/docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md new file mode 100644 index 0000000000..db6dd4c468 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md @@ -0,0 +1,85 @@ +--- +title: frauddetector_list +hide_title: false +hide_table_of_contents: false +keywords: + - frauddetector_list + - 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 +--- +Gets an individual frauddetector_list resource + +## Overview + + + + + +
Namefrauddetector_list
TypeResource
Descriptionfrauddetector_list
Idawscc.frauddetector.frauddetector_list
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe list ARN.
namestringThe name of the list.
descriptionstringThe description of the list.
variable_typestringThe variable type of the list.
created_timestringThe time when the list was created.
last_updated_timestringThe time when the list was last updated.
tagsarrayTags associated with this list.
elementsarrayThe elements in this list.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the frauddetector_list resource, the following permissions are required: + +### Read +
+frauddetector:GetListElements,
+frauddetector:GetListsMetadata,
+frauddetector:ListTagsForResource
+ +### Update +
+frauddetector:GetListElements,
+frauddetector:GetListsMetadata,
+frauddetector:ListTagsForResource,
+frauddetector:UntagResource,
+frauddetector:UpdateList,
+frauddetector:TagResource
+ +### Delete +
+frauddetector:DeleteList,
+frauddetector:GetListsMetadata
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +variable_type, +created_time, +last_updated_time, +tags, +elements +FROM awscc.frauddetector.frauddetector_list +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/index.md b/docs/awscc-docs/providers/awscc/frauddetector/index.md new file mode 100644 index 0000000000..277fb67e52 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/index.md @@ -0,0 +1,49 @@ +--- +title: frauddetector +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The frauddetector service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+detector
+detectors
+event_type
+event_types
+frauddetector_list
+label +
+
+labels
+lists
+outcome
+outcomes
+variable
+variables +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/frauddetector/label/index.md b/docs/awscc-docs/providers/awscc/frauddetector/label/index.md new file mode 100644 index 0000000000..a485b7a358 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/label/index.md @@ -0,0 +1,79 @@ +--- +title: label +hide_title: false +hide_table_of_contents: false +keywords: + - label + - 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 +--- +Gets an individual label resource + +## Overview + + + + + +
Namelabel
TypeResource
Descriptionlabel
Idawscc.frauddetector.label
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the label.
tagsarrayTags associated with this label.
descriptionstringThe label description.
arnstringThe label ARN.
created_timestringThe timestamp when the label was created.
last_updated_timestringThe timestamp when the label was last updated.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the label resource, the following permissions are required: + +### Read +
+frauddetector:GetLabels,
+frauddetector:ListTagsForResource
+ +### Update +
+frauddetector:GetLabels,
+frauddetector:PutLabel,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource,
+frauddetector:UntagResource
+ +### Delete +
+frauddetector:GetLabels,
+frauddetector:DeleteLabel
+ + +## Example +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM awscc.frauddetector.label +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/labels/index.md b/docs/awscc-docs/providers/awscc/frauddetector/labels/index.md new file mode 100644 index 0000000000..2d5cdda8aa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/labels/index.md @@ -0,0 +1,62 @@ +--- +title: labels +hide_title: false +hide_table_of_contents: false +keywords: + - labels + - 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 +--- +Retrieves a list of labels in a region + +## Overview + + + + + +
Namelabels
TypeResource
Descriptionlabels
Idawscc.frauddetector.labels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe label ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the labels resource, the following permissions are required: + +### Create +
+frauddetector:GetLabels,
+frauddetector:PutLabel,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource
+ +### List +
+frauddetector:GetLabels,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.frauddetector.labels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/lists/index.md b/docs/awscc-docs/providers/awscc/frauddetector/lists/index.md new file mode 100644 index 0000000000..0e648e0ea4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/lists/index.md @@ -0,0 +1,65 @@ +--- +title: lists +hide_title: false +hide_table_of_contents: false +keywords: + - lists + - 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 +--- +Retrieves a list of lists in a region + +## Overview + + + + + +
Namelists
TypeResource
Descriptionlists
Idawscc.frauddetector.lists
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe list ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the lists resource, the following permissions are required: + +### Create +
+frauddetector:CreateList,
+frauddetector:GetListElements,
+frauddetector:GetListsMetadata,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource,
+frauddetector:UpdateList
+ +### List +
+frauddetector:GetListElements,
+frauddetector:GetListsMetadata,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.frauddetector.lists +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md b/docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md new file mode 100644 index 0000000000..161921c549 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md @@ -0,0 +1,79 @@ +--- +title: outcome +hide_title: false +hide_table_of_contents: false +keywords: + - outcome + - 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 +--- +Gets an individual outcome resource + +## Overview + + + + + +
Nameoutcome
TypeResource
Descriptionoutcome
Idawscc.frauddetector.outcome
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the outcome.
tagsarrayTags associated with this outcome.
descriptionstringThe outcome description.
arnstringThe outcome ARN.
created_timestringThe timestamp when the outcome was created.
last_updated_timestringThe timestamp when the outcome was last updated.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the outcome resource, the following permissions are required: + +### Read +
+frauddetector:GetOutcomes,
+frauddetector:ListTagsForResource
+ +### Update +
+frauddetector:GetOutcomes,
+frauddetector:PutOutcome,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource,
+frauddetector:UntagResource
+ +### Delete +
+frauddetector:GetOutcomes,
+frauddetector:DeleteOutcome
+ + +## Example +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM awscc.frauddetector.outcome +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md b/docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md new file mode 100644 index 0000000000..1b787a4a30 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md @@ -0,0 +1,62 @@ +--- +title: outcomes +hide_title: false +hide_table_of_contents: false +keywords: + - outcomes + - 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 +--- +Retrieves a list of outcomes in a region + +## Overview + + + + + +
Nameoutcomes
TypeResource
Descriptionoutcomes
Idawscc.frauddetector.outcomes
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe outcome ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the outcomes resource, the following permissions are required: + +### Create +
+frauddetector:GetOutcomes,
+frauddetector:PutOutcome,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource
+ +### List +
+frauddetector:GetOutcomes,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.frauddetector.outcomes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/variable/index.md b/docs/awscc-docs/providers/awscc/frauddetector/variable/index.md new file mode 100644 index 0000000000..be985d3edc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/variable/index.md @@ -0,0 +1,87 @@ +--- +title: variable +hide_title: false +hide_table_of_contents: false +keywords: + - variable + - 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 +--- +Gets an individual variable resource + +## Overview + + + + + +
Namevariable
TypeResource
Descriptionvariable
Idawscc.frauddetector.variable
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the variable.
data_sourcestringThe source of the data.
data_typestringThe data type.
default_valuestringThe default value for the variable when no value is received.
descriptionstringThe description.
tagsarrayTags associated with this variable.
variable_typestringThe variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
arnstringThe ARN of the variable.
created_timestringThe time when the variable was created.
last_updated_timestringThe time when the variable was last updated.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the variable resource, the following permissions are required: + +### Read +
+frauddetector:GetVariables,
+frauddetector:ListTagsForResource
+ +### Update +
+frauddetector:GetVariables,
+frauddetector:UpdateVariable,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource,
+frauddetector:UntagResource
+ +### Delete +
+frauddetector:GetVariables,
+frauddetector:DeleteVariable
+ + +## Example +```sql +SELECT +region, +name, +data_source, +data_type, +default_value, +description, +tags, +variable_type, +arn, +created_time, +last_updated_time +FROM awscc.frauddetector.variable +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/frauddetector/variables/index.md b/docs/awscc-docs/providers/awscc/frauddetector/variables/index.md new file mode 100644 index 0000000000..2e822da151 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/frauddetector/variables/index.md @@ -0,0 +1,62 @@ +--- +title: variables +hide_title: false +hide_table_of_contents: false +keywords: + - variables + - 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 +--- +Retrieves a list of variables in a region + +## Overview + + + + + +
Namevariables
TypeResource
Descriptionvariables
Idawscc.frauddetector.variables
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the variable.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the variables resource, the following permissions are required: + +### Create +
+frauddetector:GetVariables,
+frauddetector:CreateVariable,
+frauddetector:ListTagsForResource,
+frauddetector:TagResource
+ +### List +
+frauddetector:GetVariables,
+frauddetector:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.frauddetector.variables +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/fsx/data_repository_association/index.md b/docs/awscc-docs/providers/awscc/fsx/data_repository_association/index.md new file mode 100644 index 0000000000..4e66a80d0b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fsx/data_repository_association/index.md @@ -0,0 +1,88 @@ +--- +title: data_repository_association +hide_title: false +hide_table_of_contents: false +keywords: + - data_repository_association + - 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 +--- +Gets an individual data_repository_association resource + +## Overview + + + + + +
Namedata_repository_association
TypeResource
Descriptiondata_repository_association
Idawscc.fsx.data_repository_association
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
association_idstring
resource_ar_nstring
file_system_idstringThe ID of the file system on which the data repository association is configured.
file_system_pathstringA 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``.<br/> 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.<br/> 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.
data_repository_pathstringThe 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.
batch_import_meta_data_on_createbooleanA 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``.
imported_file_chunk_sizeintegerFor 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.<br/> 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.
s3objectThe 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.
tagsarrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_repository_association resource, the following permissions are required: + +### Read +
+fsx:DescribeDataRepositoryAssociations
+ +### Update +
+fsx:DescribeDataRepositoryAssociations,
+fsx:UpdateDataRepositoryAssociation,
+fsx:TagResource,
+fsx:UntagResource,
+s3:ListBucket,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy
+ +### Delete +
+fsx:DescribeDataRepositoryAssociations,
+fsx:DeleteDataRepositoryAssociation
+ + +## Example +```sql +SELECT +region, +association_id, +resource_ar_n, +file_system_id, +file_system_path, +data_repository_path, +batch_import_meta_data_on_create, +imported_file_chunk_size, +s3, +tags +FROM awscc.fsx.data_repository_association +WHERE region = 'us-east-1' +AND data__Identifier = '<AssociationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/fsx/data_repository_associations/index.md b/docs/awscc-docs/providers/awscc/fsx/data_repository_associations/index.md new file mode 100644 index 0000000000..47f64dd5c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fsx/data_repository_associations/index.md @@ -0,0 +1,65 @@ +--- +title: data_repository_associations +hide_title: false +hide_table_of_contents: false +keywords: + - data_repository_associations + - 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 +--- +Retrieves a list of data_repository_associations in a region + +## Overview + + + + + +
Namedata_repository_associations
TypeResource
Descriptiondata_repository_associations
Idawscc.fsx.data_repository_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_repository_associations resource, the following permissions are required: + +### Create +
+fsx:CreateDataRepositoryAssociation,
+fsx:DescribeDataRepositoryAssociations,
+fsx:TagResource,
+s3:ListBucket,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy
+ +### List +
+fsx:DescribeDataRepositoryAssociations
+ + +## Example +```sql +SELECT +region, +association_id +FROM awscc.fsx.data_repository_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/fsx/index.md b/docs/awscc-docs/providers/awscc/fsx/index.md new file mode 100644 index 0000000000..e90bd0b193 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/fsx/index.md @@ -0,0 +1,39 @@ +--- +title: fsx +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The fsx service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+data_repository_association +
+
+data_repository_associations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/gamelift/alias/index.md b/docs/awscc-docs/providers/awscc/gamelift/alias/index.md new file mode 100644 index 0000000000..7412efe7c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/alias/index.md @@ -0,0 +1,69 @@ +--- +title: alias +hide_title: false +hide_table_of_contents: false +keywords: + - alias + - 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 +--- +Gets an individual alias resource + +## Overview + + + + + +
Namealias
TypeResource
Descriptionalias
Idawscc.gamelift.alias
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringA human-readable description of the alias.
namestringA descriptive label that is associated with an alias. Alias names do not need to be unique.
routing_strategyobjectA routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.
alias_idstringUnique alias ID
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alias resource, the following permissions are required: + +### Read +
+gamelift:DescribeAlias
+ +### Update +
+gamelift:UpdateAlias
+ +### Delete +
+gamelift:DeleteAlias
+ + +## Example +```sql +SELECT +region, +description, +name, +routing_strategy, +alias_id +FROM awscc.gamelift.alias +WHERE region = 'us-east-1' +AND data__Identifier = '<AliasId>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/aliases/index.md b/docs/awscc-docs/providers/awscc/gamelift/aliases/index.md new file mode 100644 index 0000000000..182cab1cb9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/aliases/index.md @@ -0,0 +1,58 @@ +--- +title: aliases +hide_title: false +hide_table_of_contents: false +keywords: + - aliases + - 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 +--- +Retrieves a list of aliases in a region + +## Overview + + + + + +
Namealiases
TypeResource
Descriptionaliases
Idawscc.gamelift.aliases
+ +## Fields + + + + + +
NameDatatypeDescription
alias_idstringUnique alias ID
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Create +
+gamelift:CreateAlias
+ +### List +
+gamelift:ListAliases
+ + +## Example +```sql +SELECT +region, +alias_id +FROM awscc.gamelift.aliases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/build/index.md b/docs/awscc-docs/providers/awscc/gamelift/build/index.md new file mode 100644 index 0000000000..72c73206bb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/build/index.md @@ -0,0 +1,74 @@ +--- +title: build +hide_title: false +hide_table_of_contents: false +keywords: + - build + - 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 +--- +Gets an individual build resource + +## Overview + + + + + +
Namebuild
TypeResource
Descriptionbuild
Idawscc.gamelift.build
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
build_idstringA 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.
namestringA descriptive label that is associated with a build. Build names do not need to be unique.
operating_systemstringThe 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.
storage_locationobjectInformation 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.
versionstringVersion information that is associated with this build. Version strings do not need to be unique.
server_sdk_versionstringA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the build resource, the following permissions are required: + +### Read +
+gamelift:DescribeBuild
+ +### Update +
+gamelift:UpdateBuild
+ +### Delete +
+gamelift:DescribeBuild,
+gamelift:DeleteBuild
+ + +## Example +```sql +SELECT +region, +build_id, +name, +operating_system, +storage_location, +version, +server_sdk_version +FROM awscc.gamelift.build +WHERE region = 'us-east-1' +AND data__Identifier = '<BuildId>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/builds/index.md b/docs/awscc-docs/providers/awscc/gamelift/builds/index.md new file mode 100644 index 0000000000..464359557c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/builds/index.md @@ -0,0 +1,59 @@ +--- +title: builds +hide_title: false +hide_table_of_contents: false +keywords: + - builds + - 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 +--- +Retrieves a list of builds in a region + +## Overview + + + + + +
Namebuilds
TypeResource
Descriptionbuilds
Idawscc.gamelift.builds
+ +## Fields + + + + + +
NameDatatypeDescription
build_idstringA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the builds resource, the following permissions are required: + +### Create +
+gamelift:DescribeBuild,
+gamelift:CreateBuild
+ +### List +
+gamelift:ListBuilds
+ + +## Example +```sql +SELECT +region, +build_id +FROM awscc.gamelift.builds +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/fleet/index.md b/docs/awscc-docs/providers/awscc/gamelift/fleet/index.md new file mode 100644 index 0000000000..fab17e9bb6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/fleet/index.md @@ -0,0 +1,139 @@ +--- +title: fleet +hide_title: false +hide_table_of_contents: false +keywords: + - fleet + - 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 +--- +Gets an individual fleet resource + +## Overview + + + + + +
Namefleet
TypeResource
Descriptionfleet
Idawscc.gamelift.fleet
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
scaling_policiesarrayA list of rules that control how a fleet is scaled.
descriptionstringA human-readable description of a fleet.
peer_vpc_idstringA 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.
apply_capacitystringDetermines whether to apply fleet or location capacities on fleet creation.
e_c2_inbound_permissionsarrayA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
compute_typestringComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
namestringA descriptive label that is associated with a fleet. Fleet names do not need to be unique.
anywhere_configurationundefinedConfiguration for Anywhere fleet.
instance_role_ar_nstringA 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.
fleet_idstringUnique fleet ID
certificate_configurationobjectIndicates 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.
instance_role_credentials_providerstringCredentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
desired_ec2_instancesinteger[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.
server_launch_parametersstringThis 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.
fleet_typestringIndicates 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.
locationsarray
new_game_session_protection_policystringA 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.
script_idstringA 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.<br/><br/>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.
max_sizeinteger[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.
runtime_configurationobjectInstructions 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.<br/><br/>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.
log_pathsarrayThis 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()
server_launch_pathstringThis 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.
min_sizeinteger[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.
peer_vpc_aws_account_idstringA 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.
metric_groupsarrayThe 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.
build_idstringA 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.
resource_creation_limit_policyobjectA policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
e_c2_instance_typestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Read +
+gamelift:DescribeFleetAttributes,
+gamelift:DescribeFleetLocationAttributes,
+gamelift:DescribeFleetCapacity,
+gamelift:DescribeFleetPortSettings,
+gamelift:DescribeFleetUtilization,
+gamelift:DescribeRuntimeConfiguration,
+gamelift:DescribeEC2InstanceLimits,
+gamelift:DescribeFleetEvents,
+gamelift:DescribeScalingPolicies
+ +### Update +
+gamelift:UpdateFleetAttributes,
+gamelift:CreateFleetLocations,
+gamelift:DeleteFleetLocations,
+gamelift:UpdateFleetCapacity,
+gamelift:UpdateFleetPortSettings,
+gamelift:UpdateRuntimeConfiguration,
+gamelift:DescribeFleetLocationCapacity,
+gamelift:DescribeFleetPortSettings,
+gamelift:DescribeFleetLocationAttributes,
+gamelift:PutScalingPolicy,
+gamelift:DescribeScalingPolicies,
+gamelift:DeleteScalingPolicy
+ +### Delete +
+gamelift:DeleteFleet,
+gamelift:DescribeFleetLocationCapacity,
+gamelift:DescribeScalingPolicies,
+gamelift:DeleteScalingPolicy
+ + +## Example +```sql +SELECT +region, +scaling_policies, +description, +peer_vpc_id, +apply_capacity, +e_c2_inbound_permissions, +compute_type, +name, +anywhere_configuration, +instance_role_ar_n, +fleet_id, +certificate_configuration, +instance_role_credentials_provider, +desired_ec2_instances, +server_launch_parameters, +fleet_type, +locations, +new_game_session_protection_policy, +script_id, +max_size, +runtime_configuration, +log_paths, +server_launch_path, +min_size, +peer_vpc_aws_account_id, +metric_groups, +build_id, +resource_creation_limit_policy, +e_c2_instance_type +FROM awscc.gamelift.fleet +WHERE region = 'us-east-1' +AND data__Identifier = '<FleetId>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/fleets/index.md b/docs/awscc-docs/providers/awscc/gamelift/fleets/index.md new file mode 100644 index 0000000000..3ee23f6e49 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/fleets/index.md @@ -0,0 +1,64 @@ +--- +title: fleets +hide_title: false +hide_table_of_contents: false +keywords: + - fleets + - 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 +--- +Retrieves a list of fleets in a region + +## Overview + + + + + +
Namefleets
TypeResource
Descriptionfleets
Idawscc.gamelift.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
fleet_idstringUnique fleet ID
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +
+gamelift:CreateFleet,
+gamelift:DescribeFleetAttributes,
+gamelift:DescribeFleetLocationAttributes,
+gamelift:UpdateFleetCapacity,
+gamelift:DescribeFleetLocationCapacity,
+gamelift:PutScalingPolicy,
+gamelift:DescribeScalingPolicies
+ +### List +
+gamelift:ListFleets
+ + +## Example +```sql +SELECT +region, +fleet_id +FROM awscc.gamelift.fleets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/game_server_group/index.md b/docs/awscc-docs/providers/awscc/gamelift/game_server_group/index.md new file mode 100644 index 0000000000..1694b4c46a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/game_server_group/index.md @@ -0,0 +1,114 @@ +--- +title: game_server_group +hide_title: false +hide_table_of_contents: false +keywords: + - game_server_group + - 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 +--- +Gets an individual game_server_group resource + +## Overview + + + + + +
Namegame_server_group
TypeResource
Descriptiongame_server_group
Idawscc.gamelift.game_server_group
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
auto_scaling_group_arnstringA generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
auto_scaling_policyobjectConfiguration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
balancing_strategystringThe 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.
delete_optionstringThe type of delete to perform.
game_server_group_arnstringA generated unique ID for the game server group.
game_server_group_namestringAn identifier for the new game server group.
game_server_protection_policystringA flag that indicates whether instances in the game server group are protected from early termination.
instance_definitionsarrayA set of EC2 instance types to use when creating instances in the group.
launch_templateobjectThe EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
max_sizenumberThe maximum number of instances allowed in the EC2 Auto Scaling group.
min_sizenumberThe minimum number of instances allowed in the EC2 Auto Scaling group.
role_arnstringThe Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
tagsarrayA list of labels to assign to the new game server group resource.
vpc_subnetsarrayA list of virtual private cloud (VPC) subnets to use with instances in the game server group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the game_server_group resource, the following permissions are required: + +### Read +
+gamelift:DescribeGameServerGroup
+ +### Update +
+gamelift:UpdateGameServerGroup,
+iam:assumeRole,
+iam:PassRole,
+autoscaling:DescribeAutoScalingGroups,
+autoscaling:UpdateAutoScalingGroup,
+autoscaling:SetInstanceProtection
+ +### Delete +
+gamelift:DeleteGameServerGroup,
+gamelift:DescribeGameServerGroup,
+iam:assumeRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeSubnets,
+ec2:DescribeLaunchTemplateVersions,
+autoscaling:CreateAutoScalingGroup,
+autoscaling:DescribeLifecycleHooks,
+autoscaling:DescribeNotificationConfigurations,
+autoscaling:DescribeAutoScalingGroups,
+autoscaling:ExitStandby,
+autoscaling:PutLifecycleHook,
+autoscaling:PutScalingPolicy,
+autoscaling:ResumeProcesses,
+autoscaling:SetInstanceProtection,
+autoscaling:UpdateAutoScalingGroup,
+autoscaling:DeleteAutoScalingGroup,
+events:PutRule,
+events:PutTargets
+ + +## Example +```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, +tags, +vpc_subnets +FROM awscc.gamelift.game_server_group +WHERE region = 'us-east-1' +AND data__Identifier = '<GameServerGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/game_server_groups/index.md b/docs/awscc-docs/providers/awscc/gamelift/game_server_groups/index.md new file mode 100644 index 0000000000..6430337455 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/game_server_groups/index.md @@ -0,0 +1,82 @@ +--- +title: game_server_groups +hide_title: false +hide_table_of_contents: false +keywords: + - game_server_groups + - 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 +--- +Retrieves a list of game_server_groups in a region + +## Overview + + + + + +
Namegame_server_groups
TypeResource
Descriptiongame_server_groups
Idawscc.gamelift.game_server_groups
+ +## Fields + + + + + +
NameDatatypeDescription
game_server_group_arnundefinedA generated unique ID for the game server group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the game_server_groups resource, the following permissions are required: + +### Create +
+gamelift:CreateGameServerGroup,
+gamelift:TagResource,
+gamelift:DescribeGameServerGroup,
+iam:assumeRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeSubnets,
+ec2:RunInstances,
+ec2:CreateTags,
+ec2:DescribeLaunchTemplateVersions,
+autoscaling:CreateAutoScalingGroup,
+autoscaling:DescribeLifecycleHooks,
+autoscaling:DescribeNotificationConfigurations,
+autoscaling:CreateAutoScalingGroup,
+autoscaling:CreateOrUpdateTags,
+autoscaling:DescribeAutoScalingGroups,
+autoscaling:ExitStandby,
+autoscaling:PutLifecycleHook,
+autoscaling:PutScalingPolicy,
+autoscaling:ResumeProcesses,
+autoscaling:SetInstanceProtection,
+autoscaling:UpdateAutoScalingGroup,
+events:PutRule,
+events:PutTargets
+ +### List +
+gamelift:ListGameServerGroups
+ + +## Example +```sql +SELECT +region, +game_server_group_arn +FROM awscc.gamelift.game_server_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/game_session_queue/index.md b/docs/awscc-docs/providers/awscc/gamelift/game_session_queue/index.md new file mode 100644 index 0000000000..a8b5737469 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/game_session_queue/index.md @@ -0,0 +1,86 @@ +--- +title: game_session_queue +hide_title: false +hide_table_of_contents: false +keywords: + - game_session_queue + - 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 +--- +Gets an individual game_session_queue resource + +## Overview + + + + + +
Namegame_session_queue
TypeResource
Descriptiongame_session_queue
Idawscc.gamelift.game_session_queue
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
timeout_in_secondsintegerThe maximum time, in seconds, that a new game session placement request remains in the queue.
destinationsarrayA list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
player_latency_policiesarrayA set of policies that act as a sliding cap on player latency.
custom_event_datastringInformation that is added to all events that are related to this game session queue.
notification_targetstringAn SNS topic ARN that is set up to receive game session placement notifications.
filter_configurationobjectA list of locations where a queue is allowed to place new game sessions.
priority_configurationobjectCustom settings to use when prioritizing destinations and locations for game session placements.
arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the game_session_queue resource, the following permissions are required: + +### Read +
+gamelift:DescribeGameSessionQueues,
+gamelift:ListTagsForResource
+ +### Delete +
+gamelift:DescribeGameSessionQueues,
+gamelift:DeleteGameSessionQueue
+ +### Update +
+gamelift:UpdateGameSessionQueue,
+gamelift:ListTagsForResource,
+gamelift:TagResource,
+gamelift:UntagResource
+ + +## Example +```sql +SELECT +region, +name, +timeout_in_seconds, +destinations, +player_latency_policies, +custom_event_data, +notification_target, +filter_configuration, +priority_configuration, +arn, +tags +FROM awscc.gamelift.game_session_queue +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/game_session_queues/index.md b/docs/awscc-docs/providers/awscc/gamelift/game_session_queues/index.md new file mode 100644 index 0000000000..f2f800f814 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/game_session_queues/index.md @@ -0,0 +1,60 @@ +--- +title: game_session_queues +hide_title: false +hide_table_of_contents: false +keywords: + - game_session_queues + - 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 +--- +Retrieves a list of game_session_queues in a region + +## Overview + + + + + +
Namegame_session_queues
TypeResource
Descriptiongame_session_queues
Idawscc.gamelift.game_session_queues
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the game_session_queues resource, the following permissions are required: + +### Create +
+gamelift:CreateGameSessionQueue,
+gamelift:ListTagsForResource,
+gamelift:TagResource
+ +### List +
+gamelift:DescribeGameSessionQueues
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.gamelift.game_session_queues +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/index.md b/docs/awscc-docs/providers/awscc/gamelift/index.md new file mode 100644 index 0000000000..947ef7b593 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/index.md @@ -0,0 +1,55 @@ +--- +title: gamelift +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The gamelift service documentation. + +:::info Service Summary + +
+
+total resources: 18
+total selectable resources: 18
+total methods: 18
+
+
+ +::: + +## Resources +
+
+alias
+aliases
+build
+builds
+fleet
+fleets
+game_server_group
+game_server_groups
+game_session_queue +
+
+game_session_queues
+location
+locations
+matchmaking_configuration
+matchmaking_configurations
+matchmaking_rule_set
+matchmaking_rule_sets
+script
+scripts +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/gamelift/location/index.md b/docs/awscc-docs/providers/awscc/gamelift/location/index.md new file mode 100644 index 0000000000..e1e8e5db67 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/location/index.md @@ -0,0 +1,71 @@ +--- +title: location +hide_title: false +hide_table_of_contents: false +keywords: + - location + - 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 +--- +Gets an individual location resource + +## Overview + + + + + +
Namelocation
TypeResource
Descriptionlocation
Idawscc.gamelift.location
+ +## Fields + + + + + + + +
NameDatatypeDescription
location_namestring
location_arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the location resource, the following permissions are required: + +### Read +
+gamelift:ListLocations,
+gamelift:ListTagsForResource
+ +### Delete +
+gamelift:DeleteLocation
+ +### Update +
+gamelift:ListLocations,
+gamelift:ListTagsForResource,
+gamelift:TagResource,
+gamelift:UntagResource
+ + +## Example +```sql +SELECT +region, +location_name, +location_arn, +tags +FROM awscc.gamelift.location +WHERE region = 'us-east-1' +AND data__Identifier = '<LocationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/locations/index.md b/docs/awscc-docs/providers/awscc/gamelift/locations/index.md new file mode 100644 index 0000000000..846eec6603 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/locations/index.md @@ -0,0 +1,61 @@ +--- +title: locations +hide_title: false +hide_table_of_contents: false +keywords: + - locations + - 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 +--- +Retrieves a list of locations in a region + +## Overview + + + + + +
Namelocations
TypeResource
Descriptionlocations
Idawscc.gamelift.locations
+ +## Fields + + + + + +
NameDatatypeDescription
location_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the locations resource, the following permissions are required: + +### Create +
+gamelift:CreateLocation,
+gamelift:ListLocations,
+gamelift:ListTagsForResource,
+gamelift:TagResource
+ +### List +
+gamelift:ListLocations
+ + +## Example +```sql +SELECT +region, +location_name +FROM awscc.gamelift.locations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md new file mode 100644 index 0000000000..10f4a837ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md @@ -0,0 +1,103 @@ +--- +title: matchmaking_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_configuration + - 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 +--- +Gets an individual matchmaking_configuration resource + +## Overview + + + + + +
Namematchmaking_configuration
TypeResource
Descriptionmatchmaking_configuration
Idawscc.gamelift.matchmaking_configuration
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
acceptance_requiredbooleanA flag that indicates whether a match that was created with this configuration must be accepted by the matched players
acceptance_timeout_secondsintegerThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additional_player_countintegerThe number of player slots in a match to keep open for future players.
backfill_modestringThe method used to backfill game sessions created with this matchmaking configuration.
arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
creation_timestringA time stamp indicating when this data object was created.
custom_event_datastringInformation to attach to all events related to the matchmaking configuration.
descriptionstringA descriptive label that is associated with matchmaking configuration.
flex_match_modestringIndicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
game_propertiesarrayA set of custom properties for a game session, formatted as key:value pairs.
game_session_datastringA set of custom game session properties, formatted as a single string value.
game_session_queue_arnsarrayThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
namestringA unique identifier for the matchmaking configuration.
notification_targetstringAn SNS topic ARN that is set up to receive matchmaking notifications.
request_timeout_secondsintegerThe maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
rule_set_arnstringThe Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
rule_set_namestringA unique identifier for the matchmaking rule set to use with this configuration.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the matchmaking_configuration resource, the following permissions are required: + +### Read +
+gamelift:DescribeMatchmakingConfigurations,
+gamelift:ListTagsForResource
+ +### Delete +
+gamelift:DescribeMatchmakingConfigurations,
+gamelift:DeleteMatchmakingConfiguration
+ +### Update +
+gamelift:DescribeMatchmakingConfigurations,
+gamelift:UpdateMatchmakingConfiguration,
+gamelift:ListTagsForResource,
+gamelift:TagResource,
+gamelift:UntagResource
+ + +## Example +```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, +tags +FROM awscc.gamelift.matchmaking_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md new file mode 100644 index 0000000000..0f00436d32 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md @@ -0,0 +1,61 @@ +--- +title: matchmaking_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_configurations + - 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 +--- +Retrieves a list of matchmaking_configurations in a region + +## Overview + + + + + +
Namematchmaking_configurations
TypeResource
Descriptionmatchmaking_configurations
Idawscc.gamelift.matchmaking_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the matchmaking_configurations resource, the following permissions are required: + +### Create +
+gamelift:CreateMatchmakingConfiguration,
+gamelift:ListTagsForResource,
+gamelift:TagResource,
+gamelift:DescribeMatchmakingConfigurations
+ +### List +
+gamelift:DescribeMatchmakingConfigurations
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.gamelift.matchmaking_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_set/index.md b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_set/index.md new file mode 100644 index 0000000000..11c27db9c8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_set/index.md @@ -0,0 +1,76 @@ +--- +title: matchmaking_rule_set +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_rule_set + - 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 +--- +Gets an individual matchmaking_rule_set resource + +## Overview + + + + + +
Namematchmaking_rule_set
TypeResource
Descriptionmatchmaking_rule_set
Idawscc.gamelift.matchmaking_rule_set
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking rule set.
rule_set_bodystringA collection of matchmaking rules, formatted as a JSON string.
creation_timestringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.
arnstringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the matchmaking_rule_set resource, the following permissions are required: + +### Read +
+gamelift:DescribeMatchmakingRuleSets,
+gamelift:ValidateMatchmakingRuleSet,
+gamelift:ListTagsForResource
+ +### Delete +
+gamelift:DeleteMatchmakingRuleSet
+ +### Update +
+gamelift:DescribeMatchmakingRuleSets,
+gamelift:ListTagsForResource,
+gamelift:TagResource,
+gamelift:UntagResource
+ + +## Example +```sql +SELECT +region, +name, +rule_set_body, +creation_time, +arn, +tags +FROM awscc.gamelift.matchmaking_rule_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_sets/index.md b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_sets/index.md new file mode 100644 index 0000000000..5c1acd5763 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_sets/index.md @@ -0,0 +1,62 @@ +--- +title: matchmaking_rule_sets +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_rule_sets + - 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 +--- +Retrieves a list of matchmaking_rule_sets in a region + +## Overview + + + + + +
Namematchmaking_rule_sets
TypeResource
Descriptionmatchmaking_rule_sets
Idawscc.gamelift.matchmaking_rule_sets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking rule set.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the matchmaking_rule_sets resource, the following permissions are required: + +### Create +
+gamelift:CreateMatchmakingRuleSet,
+gamelift:DescribeMatchmakingRuleSets,
+gamelift:ValidateMatchmakingRuleSet,
+gamelift:ListTagsForResource,
+gamelift:TagResource
+ +### List +
+gamelift:DescribeMatchmakingRuleSets
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.gamelift.matchmaking_rule_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/script/index.md b/docs/awscc-docs/providers/awscc/gamelift/script/index.md new file mode 100644 index 0000000000..37250fef41 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/script/index.md @@ -0,0 +1,84 @@ +--- +title: script +hide_title: false +hide_table_of_contents: false +keywords: + - script + - 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 +--- +Gets an individual script resource + +## Overview + + + + + +
Namescript
TypeResource
Descriptionscript
Idawscc.gamelift.script
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringA descriptive label that is associated with a script. Script names do not need to be unique.
storage_locationobjectThe 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.
versionstringThe version that is associated with a script. Version strings do not need to be unique.
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
arnstringThe 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.
idstringA unique identifier for the Realtime script
size_on_diskintegerThe file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the script resource, the following permissions are required: + +### Read +
+gamelift:DescribeScript,
+gamelift:ListScripts,
+gamelift:ListTagsForResource
+ +### Delete +
+gamelift:DeleteScript
+ +### Update +
+gamelift:DescribeScript,
+gamelift:UpdateScript,
+gamelift:ListTagsForResource,
+gamelift:TagResource,
+gamelift:UntagResource,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +name, +storage_location, +version, +tags, +creation_time, +arn, +id, +size_on_disk +FROM awscc.gamelift.script +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/gamelift/scripts/index.md b/docs/awscc-docs/providers/awscc/gamelift/scripts/index.md new file mode 100644 index 0000000000..92074a4802 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/gamelift/scripts/index.md @@ -0,0 +1,63 @@ +--- +title: scripts +hide_title: false +hide_table_of_contents: false +keywords: + - scripts + - 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 +--- +Retrieves a list of scripts in a region + +## Overview + + + + + +
Namescripts
TypeResource
Descriptionscripts
Idawscc.gamelift.scripts
+ +## Fields + + + + + +
NameDatatypeDescription
idstringA unique identifier for the Realtime script
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scripts resource, the following permissions are required: + +### Create +
+gamelift:CreateScript,
+gamelift:ListTagsForResource,
+gamelift:TagResource,
+gamelift:DescribeScript,
+iam:PassRole
+ +### List +
+gamelift:ListScripts,
+gamelift:DescribeScript
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.gamelift.scripts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md new file mode 100644 index 0000000000..e7ec225972 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md @@ -0,0 +1,85 @@ +--- +title: accelerator +hide_title: false +hide_table_of_contents: false +keywords: + - accelerator + - 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 +--- +Gets an individual accelerator resource + +## Overview + + + + + +
Nameaccelerator
TypeResource
Descriptionaccelerator
Idawscc.globalaccelerator.accelerator
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of accelerator.
ip_address_typestringIP Address type.
ip_addressesarrayThe IP addresses from BYOIP Prefix pool.
enabledbooleanIndicates whether an accelerator is enabled. The value is true or false.
dns_namestringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
ipv4_addressesarrayThe IPv4 addresses assigned to the accelerator.
ipv6_addressesarrayThe IPv6 addresses assigned if the accelerator is dualstack
dual_stack_dns_namestringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the accelerator resource, the following permissions are required: + +### Read +
+globalaccelerator:DescribeAccelerator
+ +### Update +
+globalaccelerator:UpdateAccelerator,
+globalaccelerator:TagResource,
+globalaccelerator:UntagResource,
+globalaccelerator:DescribeAccelerator
+ +### Delete +
+globalaccelerator:UpdateAccelerator,
+globalaccelerator:DeleteAccelerator,
+globalaccelerator:DescribeAccelerator
+ + +## Example +```sql +SELECT +region, +name, +ip_address_type, +ip_addresses, +enabled, +dns_name, +ipv4_addresses, +ipv6_addresses, +dual_stack_dns_name, +accelerator_arn, +tags +FROM awscc.globalaccelerator.accelerator +WHERE data__Identifier = '<AcceleratorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md new file mode 100644 index 0000000000..14d80ea523 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md @@ -0,0 +1,60 @@ +--- +title: accelerators +hide_title: false +hide_table_of_contents: false +keywords: + - accelerators + - 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 +--- +Retrieves a list of accelerators in a region + +## Overview + + + + + +
Nameaccelerators
TypeResource
Descriptionaccelerators
Idawscc.globalaccelerator.accelerators
+ +## Fields + + + + + +
NameDatatypeDescription
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the accelerators resource, the following permissions are required: + +### Create +
+globalaccelerator:CreateAccelerator,
+globalaccelerator:DescribeAccelerator,
+globalaccelerator:TagResource
+ +### List +
+globalaccelerator:ListAccelerators
+ + +## Example +```sql +SELECT +region, +accelerator_arn +FROM awscc.globalaccelerator.accelerators + +``` diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md new file mode 100644 index 0000000000..dfe3d28803 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md @@ -0,0 +1,87 @@ +--- +title: endpoint_group +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_group + - 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 +--- +Gets an individual endpoint_group resource + +## Overview + + + + + +
Nameendpoint_group
TypeResource
Descriptionendpoint_group
Idawscc.globalaccelerator.endpoint_group
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener
endpoint_group_regionstringThe name of the AWS Region where the endpoint group is located
endpoint_configurationsarrayThe list of endpoint objects.
traffic_dial_percentagenumberThe percentage of traffic to sent to an AWS Region
health_check_portintegerThe port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
health_check_protocolstringThe protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
health_check_pathstring
health_check_interval_secondsintegerThe time in seconds between each health check for an endpoint. Must be a value of 10 or 30
threshold_countintegerThe number of consecutive health checks required to set the state of the endpoint to unhealthy.
endpoint_group_arnstringThe Amazon Resource Name (ARN) of the endpoint group
port_overridesarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint_group resource, the following permissions are required: + +### Read +
+globalaccelerator:DescribeEndpointGroup
+ +### Update +
+globalaccelerator:UpdateEndpointGroup,
+globalaccelerator:DescribeEndpointGroup,
+globalaccelerator:DescribeListener,
+globalaccelerator:DescribeAccelerator
+ +### Delete +
+globalaccelerator:DeleteEndpointGroup,
+globalaccelerator:DescribeEndpointGroup,
+globalaccelerator:DescribeAccelerator
+ + +## Example +```sql +SELECT +region, +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 awscc.globalaccelerator.endpoint_group +WHERE data__Identifier = '<EndpointGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md new file mode 100644 index 0000000000..8703a18311 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md @@ -0,0 +1,63 @@ +--- +title: endpoint_groups +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_groups + - 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 +--- +Retrieves a list of endpoint_groups in a region + +## Overview + + + + + +
Nameendpoint_groups
TypeResource
Descriptionendpoint_groups
Idawscc.globalaccelerator.endpoint_groups
+ +## Fields + + + + + +
NameDatatypeDescription
endpoint_group_arnstringThe Amazon Resource Name (ARN) of the endpoint group
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint_groups resource, the following permissions are required: + +### Create +
+globalaccelerator:CreateEndpointGroup,
+globalaccelerator:DescribeEndpointGroup,
+globalaccelerator:DescribeAccelerator,
+globalaccelerator:DescribeListener,
+globalaccelerator:ListAccelerators,
+globalaccelerator:ListListeners
+ +### List +
+globalaccelerator:ListEndpointGroups
+ + +## Example +```sql +SELECT +region, +endpoint_group_arn +FROM awscc.globalaccelerator.endpoint_groups + +``` diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/index.md new file mode 100644 index 0000000000..e7e10005f2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/globalaccelerator/index.md @@ -0,0 +1,43 @@ +--- +title: globalaccelerator +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The globalaccelerator service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+accelerator
+accelerators
+endpoint_group +
+
+endpoint_groups
+listener
+listeners +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/listener/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/listener/index.md new file mode 100644 index 0000000000..f0fb13146c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/globalaccelerator/listener/index.md @@ -0,0 +1,74 @@ +--- +title: listener +hide_title: false +hide_table_of_contents: false +keywords: + - listener + - 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 +--- +Gets an individual listener resource + +## Overview + + + + + +
Namelistener
TypeResource
Descriptionlistener
Idawscc.globalaccelerator.listener
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener.
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
port_rangesarray
protocolstringThe protocol for the listener.
client_affinitystringClient affinity lets you direct all requests from a user to the same endpoint.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listener resource, the following permissions are required: + +### Read +
+globalaccelerator:DescribeListener
+ +### Update +
+globalaccelerator:UpdateListener,
+globalaccelerator:DescribeListener,
+globalaccelerator:DescribeAccelerator
+ +### Delete +
+globalaccelerator:DescribeListener,
+globalaccelerator:DeleteListener,
+globalaccelerator:DescribeAccelerator
+ + +## Example +```sql +SELECT +region, +listener_arn, +accelerator_arn, +port_ranges, +protocol, +client_affinity +FROM awscc.globalaccelerator.listener +WHERE data__Identifier = '<ListenerArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md new file mode 100644 index 0000000000..c603d8e661 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md @@ -0,0 +1,60 @@ +--- +title: listeners +hide_title: false +hide_table_of_contents: false +keywords: + - listeners + - 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 +--- +Retrieves a list of listeners in a region + +## Overview + + + + + +
Namelisteners
TypeResource
Descriptionlisteners
Idawscc.globalaccelerator.listeners
+ +## Fields + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Create +
+globalaccelerator:CreateListener,
+globalaccelerator:DescribeListener,
+globalaccelerator:DescribeAccelerator
+ +### List +
+globalaccelerator:ListListeners
+ + +## Example +```sql +SELECT +region, +listener_arn +FROM awscc.globalaccelerator.listeners + +``` diff --git a/docs/awscc-docs/providers/awscc/glue/index.md b/docs/awscc-docs/providers/awscc/glue/index.md new file mode 100644 index 0000000000..db596cd241 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/glue/index.md @@ -0,0 +1,40 @@ +--- +title: glue +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The glue service documentation. + +:::info Service Summary + +
+
+total resources: 3
+total selectable resources: 3
+total methods: 3
+
+
+ +::: + +## Resources +
+
+schema_version
+schema_version_metadata +
+
+schema_versions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/glue/schema_version/index.md b/docs/awscc-docs/providers/awscc/glue/schema_version/index.md new file mode 100644 index 0000000000..51d694eaa0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/glue/schema_version/index.md @@ -0,0 +1,64 @@ +--- +title: schema_version +hide_title: false +hide_table_of_contents: false +keywords: + - schema_version + - 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 +--- +Gets an individual schema_version resource + +## Overview + + + + + +
Nameschema_version
TypeResource
Descriptionschema_version
Idawscc.glue.schema_version
+ +## Fields + + + + + + + +
NameDatatypeDescription
schemaobject
schema_definitionstringComplete definition of the schema in plain-text.
version_idstringRepresents the version ID associated with the schema version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schema_version resource, the following permissions are required: + +### Read +
+glue:GetSchemaVersion
+ +### Delete +
+glue:DeleteSchemaVersions,
+glue:GetSchemaVersion
+ + +## Example +```sql +SELECT +region, +schema, +schema_definition, +version_id +FROM awscc.glue.schema_version +WHERE region = 'us-east-1' +AND data__Identifier = '<VersionId>' +``` diff --git a/docs/awscc-docs/providers/awscc/glue/schema_version_metadata/index.md b/docs/awscc-docs/providers/awscc/glue/schema_version_metadata/index.md new file mode 100644 index 0000000000..2cef12576c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/glue/schema_version_metadata/index.md @@ -0,0 +1,65 @@ +--- +title: schema_version_metadata +hide_title: false +hide_table_of_contents: false +keywords: + - schema_version_metadata + - 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 +--- +Gets an individual schema_version_metadata resource + +## Overview + + + + + +
Nameschema_version_metadata
TypeResource
Descriptionschema_version_metadata
Idawscc.glue.schema_version_metadata
+ +## Fields + + + + + + + +
NameDatatypeDescription
schema_version_idstringRepresents the version ID associated with the schema version.
keystringMetadata key
valuestringMetadata value
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schema_version_metadata resource, the following permissions are required: + +### Read +
+glue:querySchemaVersionMetadata
+ +### Delete +
+glue:removeSchemaVersionMetadata
+ + +## Example +```sql +SELECT +region, +schema_version_id, +key, +value +FROM awscc.glue.schema_version_metadata +WHERE region = 'us-east-1' +AND data__Identifier = '<SchemaVersionId>' +AND data__Identifier = '<Key>' +AND data__Identifier = '<Value>' +``` diff --git a/docs/awscc-docs/providers/awscc/glue/schema_versions/index.md b/docs/awscc-docs/providers/awscc/glue/schema_versions/index.md new file mode 100644 index 0000000000..52c7a891e7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/glue/schema_versions/index.md @@ -0,0 +1,60 @@ +--- +title: schema_versions +hide_title: false +hide_table_of_contents: false +keywords: + - schema_versions + - 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 +--- +Retrieves a list of schema_versions in a region + +## Overview + + + + + +
Nameschema_versions
TypeResource
Descriptionschema_versions
Idawscc.glue.schema_versions
+ +## Fields + + + + + +
NameDatatypeDescription
version_idstringRepresents the version ID associated with the schema version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schema_versions resource, the following permissions are required: + +### Create +
+glue:RegisterSchemaVersion,
+glue:GetSchemaVersion,
+glue:GetSchemaByDefinition
+ +### List +
+glue:ListSchemaVersions
+ + +## Example +```sql +SELECT +region, +version_id +FROM awscc.glue.schema_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/grafana/index.md b/docs/awscc-docs/providers/awscc/grafana/index.md new file mode 100644 index 0000000000..9957dc8267 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/grafana/index.md @@ -0,0 +1,39 @@ +--- +title: grafana +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The grafana service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+workspace +
+
+workspaces +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/grafana/workspace/index.md b/docs/awscc-docs/providers/awscc/grafana/workspace/index.md new file mode 100644 index 0000000000..1a3c384f19 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/grafana/workspace/index.md @@ -0,0 +1,131 @@ +--- +title: workspace +hide_title: false +hide_table_of_contents: false +keywords: + - workspace + - 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 +--- +Gets an individual workspace resource + +## Overview + + + + + +
Nameworkspace
TypeResource
Descriptionworkspace
Idawscc.grafana.workspace
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
authentication_providersarrayList of authentication providers to enable.
sso_client_idstringThe client ID of the AWS SSO Managed Application.
saml_configurationobject
network_access_controlobject
vpc_configurationobject
saml_configuration_statusstring
client_tokenstringA unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
statusstring
creation_timestampstringTimestamp when the workspace was created.
modification_timestampstringTimestamp when the workspace was last modified
grafana_versionstringThe version of Grafana to support in your workspace.
endpointstringEndpoint for the Grafana workspace.
account_access_typestring
organization_role_namestringThe 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.
permission_typestring
stack_set_namestringThe name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
data_sourcesarrayList of data sources on the service managed IAM role.
descriptionstringDescription of a workspace.
idstringThe id that uniquely identifies a Grafana workspace.
namestringThe user friendly name of a workspace.
notification_destinationsarrayList of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
organizational_unitsarrayList of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
role_arnstringIAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
plugin_admin_enabledbooleanAllow workspace admins to install plugins
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workspace resource, the following permissions are required: + +### Read +
+grafana:DescribeWorkspace,
+grafana:DescribeWorkspaceAuthentication,
+grafana:DescribeWorkspaceConfiguration
+ +### Update +
+grafana:DescribeWorkspace,
+grafana:DescribeWorkspaceAuthentication,
+grafana:DescribeWorkspaceConfiguration,
+grafana:UpdateWorkspace,
+grafana:UpdateWorkspaceAuthentication,
+grafana:UpdateWorkspaceConfiguration,
+sso:DescribeRegisteredRegions,
+sso:CreateManagedApplicationInstance,
+ec2:GetManagedPrefixListEntries,
+iam:PassRole,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+iam:CreateServiceLinkedRole,
+sso:ListApplicationInstances,
+sso:GetApplicationInstance
+ +### Delete +
+grafana:DeleteWorkspace,
+grafana:DescribeWorkspace,
+grafana:DescribeWorkspaceAuthentication,
+grafana:DescribeWorkspaceConfiguration,
+sso:DeleteManagedApplicationInstance,
+sso:DescribeRegisteredRegions
+ + +## Example +```sql +SELECT +region, +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 awscc.grafana.workspace +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/grafana/workspaces/index.md b/docs/awscc-docs/providers/awscc/grafana/workspaces/index.md new file mode 100644 index 0000000000..e5c043c549 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/grafana/workspaces/index.md @@ -0,0 +1,76 @@ +--- +title: workspaces +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces + - 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 +--- +Retrieves a list of workspaces in a region + +## Overview + + + + + +
Nameworkspaces
TypeResource
Descriptionworkspaces
Idawscc.grafana.workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe id that uniquely identifies a Grafana workspace.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workspaces resource, the following permissions are required: + +### Create +
+grafana:CreateWorkspace,
+grafana:DescribeWorkspace,
+grafana:DescribeWorkspaceAuthentication,
+grafana:DescribeWorkspaceConfiguration,
+grafana:UpdateWorkspaceAuthentication,
+sso:DescribeRegisteredRegions,
+sso:CreateManagedApplicationInstance,
+organizations:DescribeOrganization,
+sso:GetSharedSsoConfiguration,
+iam:PassRole,
+ec2:GetManagedPrefixListEntries,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+iam:CreateServiceLinkedRole,
+sso:ListApplicationInstances,
+sso:GetApplicationInstance
+ +### List +
+grafana:ListWorkspaces,
+grafana:DescribeWorkspaceAuthentication,
+grafana:DescribeWorkspaceConfiguration
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.grafana.workspaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md new file mode 100644 index 0000000000..35545eb946 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md @@ -0,0 +1,77 @@ +--- +title: component_version +hide_title: false +hide_table_of_contents: false +keywords: + - component_version + - 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 +--- +Gets an individual component_version resource + +## Overview + + + + + +
Namecomponent_version
TypeResource
Descriptioncomponent_version
Idawscc.greengrassv2.component_version
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
component_namestring
component_versionstring
inline_recipestring
lambda_functionobject
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the component_version resource, the following permissions are required: + +### Read +
+greengrass:DescribeComponent,
+greengrass:ListTagsForResource
+ +### Update +
+greengrass:DescribeComponent,
+greengrass:ListTagsForResource,
+greengrass:TagResource,
+greengrass:UntagResource
+ +### Delete +
+greengrass:DeleteComponent
+ + +## Example +```sql +SELECT +region, +arn, +component_name, +component_version, +inline_recipe, +lambda_function, +tags +FROM awscc.greengrassv2.component_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md new file mode 100644 index 0000000000..e217b8686d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md @@ -0,0 +1,63 @@ +--- +title: component_versions +hide_title: false +hide_table_of_contents: false +keywords: + - component_versions + - 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 +--- +Retrieves a list of component_versions in a region + +## Overview + + + + + +
Namecomponent_versions
TypeResource
Descriptioncomponent_versions
Idawscc.greengrassv2.component_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the component_versions resource, the following permissions are required: + +### Create +
+greengrass:CreateComponentVersion,
+greengrass:DescribeComponent,
+greengrass:ListTagsForResource,
+greengrass:TagResource,
+lambda:GetFunction,
+s3:GetObject
+ +### List +
+greengrass:ListComponentVersions
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.greengrassv2.component_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md new file mode 100644 index 0000000000..5a193ac636 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md @@ -0,0 +1,88 @@ +--- +title: deployment +hide_title: false +hide_table_of_contents: false +keywords: + - deployment + - 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 +--- +Gets an individual deployment resource + +## Overview + + + + + +
Namedeployment
TypeResource
Descriptiondeployment
Idawscc.greengrassv2.deployment
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
target_arnstring
parent_target_arnstring
deployment_idstring
deployment_namestring
componentsobject
iot_job_configurationobject
deployment_policiesobject
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployment resource, the following permissions are required: + +### Read +
+greengrass:GetDeployment,
+iot:DescribeJob,
+iot:DescribeThing,
+iot:DescribeThingGroup,
+iot:GetThingShadow
+ +### Update +
+greengrass:GetDeployment,
+greengrass:TagResource,
+greengrass:UntagResource,
+iot:DescribeJob
+ +### Delete +
+greengrass:DeleteDeployment,
+greengrass:CancelDeployment,
+iot:CancelJob,
+iot:DeleteJob,
+iot:DescribeJob
+ + +## Example +```sql +SELECT +region, +target_arn, +parent_target_arn, +deployment_id, +deployment_name, +components, +iot_job_configuration, +deployment_policies, +tags +FROM awscc.greengrassv2.deployment +WHERE region = 'us-east-1' +AND data__Identifier = '<DeploymentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md new file mode 100644 index 0000000000..532a48759a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md @@ -0,0 +1,73 @@ +--- +title: deployments +hide_title: false +hide_table_of_contents: false +keywords: + - deployments + - 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 +--- +Retrieves a list of deployments in a region + +## Overview + + + + + +
Namedeployments
TypeResource
Descriptiondeployments
Idawscc.greengrassv2.deployments
+ +## Fields + + + + + +
NameDatatypeDescription
deployment_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +
+greengrass:CreateDeployment,
+greengrass:GetDeployment,
+greengrass:TagResource,
+iot:CancelJob,
+iot:CreateJob,
+iot:DeleteThingShadow,
+iot:DescribeJob,
+iot:DescribeThing,
+iot:DescribeThingGroup,
+iot:GetThingShadow,
+iot:UpdateJob,
+iot:UpdateThingShadow
+ +### List +
+greengrass:ListDeployments,
+iot:DescribeJob,
+iot:DescribeThing,
+iot:DescribeThingGroup,
+iot:GetThingShadow
+ + +## Example +```sql +SELECT +region, +deployment_id +FROM awscc.greengrassv2.deployments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/index.md new file mode 100644 index 0000000000..2e22f5a826 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/greengrassv2/index.md @@ -0,0 +1,41 @@ +--- +title: greengrassv2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The greengrassv2 service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+component_version
+component_versions +
+
+deployment
+deployments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/groundstation/config/index.md b/docs/awscc-docs/providers/awscc/groundstation/config/index.md new file mode 100644 index 0000000000..61c20ccffa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/groundstation/config/index.md @@ -0,0 +1,78 @@ +--- +title: config +hide_title: false +hide_table_of_contents: false +keywords: + - config + - 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 +--- +Gets an individual config resource + +## Overview + + + + + +
Nameconfig
TypeResource
Descriptionconfig
Idawscc.groundstation.config
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestring
tagsarray
typestring
config_dataobject
arnstring
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the config resource, the following permissions are required: + +### Read +
+groundstation:GetConfig,
+groundstation:ListTagsForResource
+ +### Update +
+groundstation:UpdateConfig,
+groundstation:ListTagsForResource,
+groundstation:TagResource,
+groundstation:UntagResource,
+iam:PassRole
+ +### Delete +
+groundstation:DeleteConfig
+ + +## Example +```sql +SELECT +region, +name, +tags, +type, +config_data, +arn, +id +FROM awscc.groundstation.config +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/groundstation/configs/index.md b/docs/awscc-docs/providers/awscc/groundstation/configs/index.md new file mode 100644 index 0000000000..4ce4d539ed --- /dev/null +++ b/docs/awscc-docs/providers/awscc/groundstation/configs/index.md @@ -0,0 +1,60 @@ +--- +title: configs +hide_title: false +hide_table_of_contents: false +keywords: + - configs + - 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 +--- +Retrieves a list of configs in a region + +## Overview + + + + + +
Nameconfigs
TypeResource
Descriptionconfigs
Idawscc.groundstation.configs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configs resource, the following permissions are required: + +### Create +
+groundstation:CreateConfig,
+groundstation:TagResource,
+iam:PassRole
+ +### List +
+groundstation:ListConfigs
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.groundstation.configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_group/index.md b/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_group/index.md new file mode 100644 index 0000000000..60f150c9f9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_group/index.md @@ -0,0 +1,71 @@ +--- +title: dataflow_endpoint_group +hide_title: false +hide_table_of_contents: false +keywords: + - dataflow_endpoint_group + - 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 +--- +Gets an individual dataflow_endpoint_group resource + +## Overview + + + + + +
Namedataflow_endpoint_group
TypeResource
Descriptiondataflow_endpoint_group
Idawscc.groundstation.dataflow_endpoint_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
endpoint_detailsarray
contact_pre_pass_duration_secondsintegerAmount 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.
contact_post_pass_duration_secondsintegerAmount 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.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataflow_endpoint_group resource, the following permissions are required: + +### Read +
+groundstation:GetDataflowEndpointGroup,
+groundstation:ListTagsForResource
+ +### Delete +
+groundstation:DeleteDataflowEndpointGroup,
+groundstation:GetDataflowEndpointGroup
+ + +## Example +```sql +SELECT +region, +id, +arn, +endpoint_details, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +tags +FROM awscc.groundstation.dataflow_endpoint_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_groups/index.md b/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_groups/index.md new file mode 100644 index 0000000000..9a47b7607c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_groups/index.md @@ -0,0 +1,64 @@ +--- +title: dataflow_endpoint_groups +hide_title: false +hide_table_of_contents: false +keywords: + - dataflow_endpoint_groups + - 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 +--- +Retrieves a list of dataflow_endpoint_groups in a region + +## Overview + + + + + +
Namedataflow_endpoint_groups
TypeResource
Descriptiondataflow_endpoint_groups
Idawscc.groundstation.dataflow_endpoint_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataflow_endpoint_groups resource, the following permissions are required: + +### Create +
+groundstation:CreateDataflowEndpointGroup,
+groundstation:GetDataflowEndpointGroup,
+groundstation:TagResource,
+iam:PassRole,
+ec2:describeAddresses,
+ec2:describeNetworkInterfaces,
+iam:createServiceLinkedRole
+ +### List +
+groundstation:ListDataflowEndpointGroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.groundstation.dataflow_endpoint_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/groundstation/index.md b/docs/awscc-docs/providers/awscc/groundstation/index.md new file mode 100644 index 0000000000..35e0f7cc5c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/groundstation/index.md @@ -0,0 +1,43 @@ +--- +title: groundstation +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The groundstation service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+config
+configs
+dataflow_endpoint_group +
+
+dataflow_endpoint_groups
+mission_profile
+mission_profiles +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/groundstation/mission_profile/index.md b/docs/awscc-docs/providers/awscc/groundstation/mission_profile/index.md new file mode 100644 index 0000000000..71eeea6151 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/groundstation/mission_profile/index.md @@ -0,0 +1,97 @@ +--- +title: mission_profile +hide_title: false +hide_table_of_contents: false +keywords: + - mission_profile + - 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 +--- +Gets an individual mission_profile resource + +## Overview + + + + + +
Namemission_profile
TypeResource
Descriptionmission_profile
Idawscc.groundstation.mission_profile
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringA name used to identify a mission profile.
contact_pre_pass_duration_secondsintegerPre-pass time needed before the contact.
contact_post_pass_duration_secondsintegerPost-pass time needed after the contact.
minimum_viable_contact_duration_secondsintegerVisibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.
streams_kms_keyobjectThe ARN of a KMS Key used for encrypting data during transmission from the source to destination locations.
streams_kms_rolestringThe ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.
dataflow_edgesarray
tracking_config_arnstring
tagsarray
idstring
arnstring
regionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the mission_profile resource, the following permissions are required: + +### Read +
+groundstation:GetMissionProfile,
+groundstation:ListTagsForResource,
+kms:DescribeKey,
+kms:CreateGrant
+ +### Update +
+groundstation:UpdateMissionProfile,
+groundstation:GetMissionProfile,
+groundstation:ListTagsForResource,
+groundstation:TagResource,
+groundstation:UntagResource,
+iam:PassRole,
+kms:DescribeKey,
+kms:CreateGrant
+ +### Delete +
+groundstation:DeleteMissionProfile,
+groundstation:GetMissionProfile
+ + +## Example +```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, +region +FROM awscc.groundstation.mission_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md b/docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md new file mode 100644 index 0000000000..5f40774a22 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md @@ -0,0 +1,65 @@ +--- +title: mission_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - mission_profiles + - 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 +--- +Retrieves a list of mission_profiles in a region + +## Overview + + + + + +
Namemission_profiles
TypeResource
Descriptionmission_profiles
Idawscc.groundstation.mission_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the mission_profiles resource, the following permissions are required: + +### Create +
+groundstation:CreateMissionProfile,
+groundstation:GetMissionProfile,
+groundstation:TagResource,
+iam:PassRole,
+kms:DescribeKey,
+kms:CreateGrant
+ +### List +
+groundstation:ListMissionProfiles
+ + +## Example +```sql +SELECT +region, +id, +arn +FROM awscc.groundstation.mission_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/detector/index.md b/docs/awscc-docs/providers/awscc/guardduty/detector/index.md new file mode 100644 index 0000000000..28150dd3cd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/detector/index.md @@ -0,0 +1,79 @@ +--- +title: detector +hide_title: false +hide_table_of_contents: false +keywords: + - detector + - 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 +--- +Gets an individual detector resource + +## Overview + + + + + +
Namedetector
TypeResource
Descriptiondetector
Idawscc.guardduty.detector
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
finding_publishing_frequencystring
enableboolean
data_sourcesobject
featuresarray
idstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the detector resource, the following permissions are required: + +### Read +
+guardduty:GetDetector
+ +### Delete +
+guardduty:ListDetectors,
+guardduty:DeleteDetector,
+guardduty:GetDetector
+ +### Update +
+guardduty:UpdateDetector,
+guardduty:GetDetector,
+guardduty:ListDetectors,
+iam:CreateServiceLinkedRole,
+iam:GetRole
+ + +## Example +```sql +SELECT +region, +finding_publishing_frequency, +enable, +data_sources, +features, +id, +tags +FROM awscc.guardduty.detector +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/detectors/index.md b/docs/awscc-docs/providers/awscc/guardduty/detectors/index.md new file mode 100644 index 0000000000..2c07dee186 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/detectors/index.md @@ -0,0 +1,62 @@ +--- +title: detectors +hide_title: false +hide_table_of_contents: false +keywords: + - detectors + - 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 +--- +Retrieves a list of detectors in a region + +## Overview + + + + + +
Namedetectors
TypeResource
Descriptiondetectors
Idawscc.guardduty.detectors
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the detectors resource, the following permissions are required: + +### Create +
+guardduty:CreateDetector,
+guardduty:GetDetector,
+guardduty:TagResource,
+iam:CreateServiceLinkedRole,
+iam:GetRole
+ +### List +
+guardduty:ListDetectors
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.guardduty.detectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/filter/index.md b/docs/awscc-docs/providers/awscc/guardduty/filter/index.md new file mode 100644 index 0000000000..560fb6c9b8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/filter/index.md @@ -0,0 +1,81 @@ +--- +title: filter +hide_title: false +hide_table_of_contents: false +keywords: + - filter + - 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 +--- +Gets an individual filter resource + +## Overview + + + + + +
Namefilter
TypeResource
Descriptionfilter
Idawscc.guardduty.filter
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
actionstring
descriptionstring
detector_idstring
finding_criteriaobject
rankinteger
namestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the filter resource, the following permissions are required: + +### Read +
+guardduty:GetFilter
+ +### Delete +
+guardduty:ListDetectors,
+guardduty:ListFilters,
+guardduty:GetFilter,
+guardduty:DeleteFilter
+ +### Update +
+guardduty:UpdateFilter,
+guardduty:GetFilter,
+guardduty:ListFilters
+ + +## Example +```sql +SELECT +region, +action, +description, +detector_id, +finding_criteria, +rank, +name, +tags +FROM awscc.guardduty.filter +WHERE region = 'us-east-1' +AND data__Identifier = '<DetectorId>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/filters/index.md b/docs/awscc-docs/providers/awscc/guardduty/filters/index.md new file mode 100644 index 0000000000..51bbc7eb05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/filters/index.md @@ -0,0 +1,62 @@ +--- +title: filters +hide_title: false +hide_table_of_contents: false +keywords: + - filters + - 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 +--- +Retrieves a list of filters in a region + +## Overview + + + + + +
Namefilters
TypeResource
Descriptionfilters
Idawscc.guardduty.filters
+ +## Fields + + + + + + +
NameDatatypeDescription
detector_idstring
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the filters resource, the following permissions are required: + +### Create +
+guardduty:CreateFilter,
+guardduty:GetFilter,
+guardduty:TagResource
+ +### List +
+guardduty:ListFilters
+ + +## Example +```sql +SELECT +region, +detector_id, +name +FROM awscc.guardduty.filters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/index.md b/docs/awscc-docs/providers/awscc/guardduty/index.md new file mode 100644 index 0000000000..93e0669016 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/index.md @@ -0,0 +1,49 @@ +--- +title: guardduty +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The guardduty service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+detector
+detectors
+filter
+filters
+ip_set
+ip_sets +
+
+master
+masters
+member
+members
+threat_intel_set
+threat_intel_sets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/guardduty/ip_set/index.md b/docs/awscc-docs/providers/awscc/guardduty/ip_set/index.md new file mode 100644 index 0000000000..5704e98b24 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/ip_set/index.md @@ -0,0 +1,84 @@ +--- +title: ip_set +hide_title: false +hide_table_of_contents: false +keywords: + - ip_set + - 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 +--- +Gets an individual ip_set resource + +## Overview + + + + + +
Nameip_set
TypeResource
Descriptionip_set
Idawscc.guardduty.ip_set
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
formatstring
activateboolean
detector_idstring
namestring
locationstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ip_set resource, the following permissions are required: + +### Read +
+guardduty:GetIPSet
+ +### Delete +
+guardduty:GetDetector,
+guardduty:ListDetectors,
+guardduty:ListIPSets,
+guardduty:GetIPSet,
+guardduty:DeleteIPSet,
+iam:DeleteRolePolicy
+ +### Update +
+guardduty:UpdateIPSet,
+guardduty:GetIPSet,
+guardduty:ListIPSets,
+iam:PutRolePolicy
+ + +## Example +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM awscc.guardduty.ip_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +AND data__Identifier = '<DetectorId>' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md b/docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md new file mode 100644 index 0000000000..823e5ef486 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md @@ -0,0 +1,63 @@ +--- +title: ip_sets +hide_title: false +hide_table_of_contents: false +keywords: + - ip_sets + - 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 +--- +Retrieves a list of ip_sets in a region + +## Overview + + + + + +
Nameip_sets
TypeResource
Descriptionip_sets
Idawscc.guardduty.ip_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
detector_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ip_sets resource, the following permissions are required: + +### Create +
+guardduty:CreateIPSet,
+guardduty:GetIPSet,
+guardduty:TagResource,
+iam:PutRolePolicy
+ +### List +
+guardduty:ListIPSets
+ + +## Example +```sql +SELECT +region, +id, +detector_id +FROM awscc.guardduty.ip_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/master/index.md b/docs/awscc-docs/providers/awscc/guardduty/master/index.md new file mode 100644 index 0000000000..7cc189f93c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/master/index.md @@ -0,0 +1,64 @@ +--- +title: master +hide_title: false +hide_table_of_contents: false +keywords: + - master + - 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 +--- +Gets an individual master resource + +## Overview + + + + + +
Namemaster
TypeResource
Descriptionmaster
Idawscc.guardduty.master
+ +## Fields + + + + + + + +
NameDatatypeDescription
master_idstringID of the account used as the master account.
invitation_idstringValue used to validate the master account to the member account.
detector_idstringUnique ID of the detector of the GuardDuty member account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the master resource, the following permissions are required: + +### Read +
+guardduty:GetMasterAccount
+ +### Delete +
+guardduty:DisassociateFromMasterAccount
+ + +## Example +```sql +SELECT +region, +master_id, +invitation_id, +detector_id +FROM awscc.guardduty.master +WHERE region = 'us-east-1' +AND data__Identifier = '<DetectorId>' +AND data__Identifier = '<MasterId>' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/masters/index.md b/docs/awscc-docs/providers/awscc/guardduty/masters/index.md new file mode 100644 index 0000000000..124e6f1394 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/masters/index.md @@ -0,0 +1,62 @@ +--- +title: masters +hide_title: false +hide_table_of_contents: false +keywords: + - masters + - 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 +--- +Retrieves a list of masters in a region + +## Overview + + + + + +
Namemasters
TypeResource
Descriptionmasters
Idawscc.guardduty.masters
+ +## Fields + + + + + + +
NameDatatypeDescription
detector_idstringUnique ID of the detector of the GuardDuty member account.
master_idstringID of the account used as the master account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the masters resource, the following permissions are required: + +### Create +
+guardduty:ListInvitations,
+guardduty:AcceptInvitation,
+guardduty:GetMasterAccount
+ +### List +
+guardduty:GetMasterAccount
+ + +## Example +```sql +SELECT +region, +detector_id, +master_id +FROM awscc.guardduty.masters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/member/index.md b/docs/awscc-docs/providers/awscc/guardduty/member/index.md new file mode 100644 index 0000000000..e40699de38 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/member/index.md @@ -0,0 +1,81 @@ +--- +title: member +hide_title: false +hide_table_of_contents: false +keywords: + - member + - 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 +--- +Gets an individual member resource + +## Overview + + + + + +
Namemember
TypeResource
Descriptionmember
Idawscc.guardduty.member
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
statusstring
member_idstring
emailstring
messagestring
disable_email_notificationboolean
detector_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the member resource, the following permissions are required: + +### Read +
+guardduty:GetMembers
+ +### Delete +
+guardduty:GetMembers,
+guardduty:DisassociateMembers,
+guardduty:DeleteMembers
+ +### Update +
+guardduty:GetMembers,
+guardduty:CreateMembers,
+guardduty:DisassociateMembers,
+guardduty:StartMonitoringMembers,
+guardduty:StopMonitoringMembers,
+guardduty:InviteMembers
+ + +## Example +```sql +SELECT +region, +status, +member_id, +email, +message, +disable_email_notification, +detector_id +FROM awscc.guardduty.member +WHERE region = 'us-east-1' +AND data__Identifier = '<DetectorId>' +AND data__Identifier = '<MemberId>' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/members/index.md b/docs/awscc-docs/providers/awscc/guardduty/members/index.md new file mode 100644 index 0000000000..cb903691bc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/members/index.md @@ -0,0 +1,61 @@ +--- +title: members +hide_title: false +hide_table_of_contents: false +keywords: + - members + - 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 +--- +Retrieves a list of members in a region + +## Overview + + + + + +
Namemembers
TypeResource
Descriptionmembers
Idawscc.guardduty.members
+ +## Fields + + + + + + +
NameDatatypeDescription
detector_idstring
member_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the members resource, the following permissions are required: + +### Create +
+guardduty:CreateMembers,
+guardduty:GetMembers
+ +### List +
+guardduty:ListMembers
+ + +## Example +```sql +SELECT +region, +detector_id, +member_id +FROM awscc.guardduty.members +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/threat_intel_set/index.md b/docs/awscc-docs/providers/awscc/guardduty/threat_intel_set/index.md new file mode 100644 index 0000000000..a1e65deea9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/threat_intel_set/index.md @@ -0,0 +1,83 @@ +--- +title: threat_intel_set +hide_title: false +hide_table_of_contents: false +keywords: + - threat_intel_set + - 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 +--- +Gets an individual threat_intel_set resource + +## Overview + + + + + +
Namethreat_intel_set
TypeResource
Descriptionthreat_intel_set
Idawscc.guardduty.threat_intel_set
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
formatstring
activateboolean
detector_idstring
namestring
locationstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the threat_intel_set resource, the following permissions are required: + +### Read +
+guardduty:GetThreatIntelSet
+ +### Delete +
+guardduty:ListDetectors,
+guardduty:ListThreatIntelSets,
+guardduty:DeleteThreatIntelSet,
+guardduty:GetThreatIntelSet,
+iam:DeleteRolePolicy
+ +### Update +
+guardduty:UpdateThreatIntelSet,
+guardduty:GetThreatIntelSet,
+guardduty:ListThreatIntelSets,
+iam:PutRolePolicy
+ + +## Example +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM awscc.guardduty.threat_intel_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +AND data__Identifier = '<DetectorId>' +``` diff --git a/docs/awscc-docs/providers/awscc/guardduty/threat_intel_sets/index.md b/docs/awscc-docs/providers/awscc/guardduty/threat_intel_sets/index.md new file mode 100644 index 0000000000..6ffc1dec14 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/guardduty/threat_intel_sets/index.md @@ -0,0 +1,63 @@ +--- +title: threat_intel_sets +hide_title: false +hide_table_of_contents: false +keywords: + - threat_intel_sets + - 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 +--- +Retrieves a list of threat_intel_sets in a region + +## Overview + + + + + +
Namethreat_intel_sets
TypeResource
Descriptionthreat_intel_sets
Idawscc.guardduty.threat_intel_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
detector_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the threat_intel_sets resource, the following permissions are required: + +### Create +
+guardduty:CreateThreatIntelSet,
+guardduty:GetThreatIntelSet,
+guardduty:TagResource,
+iam:PutRolePolicy
+ +### List +
+guardduty:ListThreatIntelSets
+ + +## Example +```sql +SELECT +region, +id, +detector_id +FROM awscc.guardduty.threat_intel_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md b/docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md new file mode 100644 index 0000000000..09b2857ecc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md @@ -0,0 +1,80 @@ +--- +title: datastore +hide_title: false +hide_table_of_contents: false +keywords: + - datastore + - 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 +--- +Gets an individual datastore resource + +## Overview + + + + + +
Namedatastore
TypeResource
Descriptiondatastore
Idawscc.healthimaging.datastore
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
datastore_arnstring
datastore_namestring
datastore_idstring
datastore_statusstring
kms_key_arnstring
created_atstring
updated_atstring
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the datastore resource, the following permissions are required: + +### Read +
+medical-imaging:GetDatastore,
+medical-imaging:ListTagsForResource
+ +### Delete +
+medical-imaging:DeleteDatastore,
+medical-imaging:GetDatastore,
+medical-imaging:UntagResource,
+kms:DescribeKey,
+kms:RetireGrant,
+kms:GenerateDataKey,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +datastore_arn, +datastore_name, +datastore_id, +datastore_status, +kms_key_arn, +created_at, +updated_at, +tags +FROM awscc.healthimaging.datastore +WHERE region = 'us-east-1' +AND data__Identifier = '<DatastoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md b/docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md new file mode 100644 index 0000000000..1642b34343 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md @@ -0,0 +1,68 @@ +--- +title: datastores +hide_title: false +hide_table_of_contents: false +keywords: + - datastores + - 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 +--- +Retrieves a list of datastores in a region + +## Overview + + + + + +
Namedatastores
TypeResource
Descriptiondatastores
Idawscc.healthimaging.datastores
+ +## Fields + + + + + +
NameDatatypeDescription
datastore_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the datastores resource, the following permissions are required: + +### Create +
+medical-imaging:CreateDatastore,
+medical-imaging:GetDatastore,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:RetireGrant,
+kms:GenerateDataKey,
+kms:Decrypt,
+lambda:InvokeFunction,
+medical-imaging:TagResource,
+medical-imaging:UntagResource,
+medical-imaging:ListTagsForResource
+ +### List +
+medical-imaging:ListDatastores
+ + +## Example +```sql +SELECT +region, +datastore_id +FROM awscc.healthimaging.datastores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/healthimaging/index.md b/docs/awscc-docs/providers/awscc/healthimaging/index.md new file mode 100644 index 0000000000..3f2549dbb6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/healthimaging/index.md @@ -0,0 +1,39 @@ +--- +title: healthimaging +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The healthimaging service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+datastore +
+
+datastores +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/healthlake/fhir_datastore/index.md b/docs/awscc-docs/providers/awscc/healthlake/fhir_datastore/index.md new file mode 100644 index 0000000000..bbeafe8152 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/healthlake/fhir_datastore/index.md @@ -0,0 +1,98 @@ +--- +title: fhir_datastore +hide_title: false +hide_table_of_contents: false +keywords: + - fhir_datastore + - 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 +--- +Gets an individual fhir_datastore resource + +## Overview + + + + + +
Namefhir_datastore
TypeResource
Descriptionfhir_datastore
Idawscc.healthlake.fhir_datastore
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
created_atobject
datastore_arnstring
datastore_endpointstring
datastore_idstring
datastore_namestring
datastore_statusstring
datastore_type_versionstring
preload_data_configobject
sse_configurationobject
identity_provider_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fhir_datastore resource, the following permissions are required: + +### Read +
+healthlake:DescribeFHIRDatastore,
+healthlake:ListTagsForResource
+ +### Update +
+healthlake:TagResource,
+healthlake:UntagResource,
+healthlake:ListTagsForResource,
+healthlake:DescribeFHIRDatastore,
+iam:PassRole,
+iam:GetRole,
+iam:CreateServiceLinkedRole
+ +### Delete +
+healthlake:DeleteFHIRDatastore,
+healthlake:DescribeFHIRDatastore,
+iam:PassRole,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+ram:GetResourceShareInvitations,
+ram:AcceptResourceShareInvitation,
+glue:CreateDatabase,
+glue:DeleteDatabase
+ + +## Example +```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, +tags +FROM awscc.healthlake.fhir_datastore +WHERE region = 'us-east-1' +AND data__Identifier = '<DatastoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md b/docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md new file mode 100644 index 0000000000..769cdab98b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md @@ -0,0 +1,74 @@ +--- +title: fhir_datastores +hide_title: false +hide_table_of_contents: false +keywords: + - fhir_datastores + - 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 +--- +Retrieves a list of fhir_datastores in a region + +## Overview + + + + + +
Namefhir_datastores
TypeResource
Descriptionfhir_datastores
Idawscc.healthlake.fhir_datastores
+ +## Fields + + + + + +
NameDatatypeDescription
datastore_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fhir_datastores resource, the following permissions are required: + +### Create +
+healthlake:CreateFHIRDatastore,
+healthlake:DescribeFHIRDatastore,
+iam:PassRole,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:GenerateDataKey,
+kms:Decrypt,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+ram:GetResourceShareInvitations,
+ram:AcceptResourceShareInvitation,
+glue:CreateDatabase,
+glue:DeleteDatabase,
+lambda:InvokeFunction,
+healthlake:TagResource,
+healthlake:UntagResource,
+healthlake:ListTagsForResource
+ +### List +
+healthlake:ListFHIRDatastores
+ + +## Example +```sql +SELECT +region, +datastore_id +FROM awscc.healthlake.fhir_datastores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/healthlake/index.md b/docs/awscc-docs/providers/awscc/healthlake/index.md new file mode 100644 index 0000000000..74a7a40818 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/healthlake/index.md @@ -0,0 +1,39 @@ +--- +title: healthlake +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The healthlake service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+fhir_datastore +
+
+fhir_datastores +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iam/group/index.md b/docs/awscc-docs/providers/awscc/iam/group/index.md new file mode 100644 index 0000000000..b0701d3505 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/group/index.md @@ -0,0 +1,85 @@ +--- +title: group +hide_title: false +hide_table_of_contents: false +keywords: + - group + - 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 +--- +Gets an individual group resource + +## Overview + + + + + +
Namegroup
TypeResource
Descriptiongroup
Idawscc.iam.group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringThe Arn of the group to create
group_namestringThe name of the group to create
managed_policy_arnsarrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
pathstringThe path to the group
policiesarrayAdds or updates an inline policy document that is embedded in the specified IAM group
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +
+iam:GetGroup,
+iam:ListGroupPolicies,
+iam:GetGroupPolicy,
+iam:ListAttachedGroupPolicies
+ +### Update +
+iam:GetGroup,
+iam:UpdateGroup,
+iam:DetachGroupPolicy,
+iam:AttachGroupPolicy,
+iam:DeleteGroupPolicy,
+iam:PutGroupPolicy,
+iam:GetGroupPolicy
+ +### Delete +
+iam:GetGroup,
+iam:DeleteGroup,
+iam:ListAttachedGroupPolicies,
+iam:ListGroupPolicies,
+iam:DetachGroupPolicy,
+iam:DeleteGroupPolicy,
+iam:GetGroupPolicy
+ + +## Example +```sql +SELECT +region, +arn, +group_name, +managed_policy_arns, +path, +policies +FROM awscc.iam.group +WHERE data__Identifier = '<GroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/group_policies/index.md b/docs/awscc-docs/providers/awscc/iam/group_policies/index.md new file mode 100644 index 0000000000..acfa008f56 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/group_policies/index.md @@ -0,0 +1,57 @@ +--- +title: group_policies +hide_title: false +hide_table_of_contents: false +keywords: + - group_policies + - 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 +--- +Retrieves a list of group_policies in a region + +## Overview + + + + + +
Namegroup_policies
TypeResource
Descriptiongroup_policies
Idawscc.iam.group_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_namestringThe name of the policy document.<br/> 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: _+=,.@-
group_namestringThe name of the group to associate the policy with.<br/> 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: _+=,.@-.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group_policies resource, the following permissions are required: + +### Create +
+iam:PutGroupPolicy,
+iam:GetGroupPolicy
+ + +## Example +```sql +SELECT +region, +policy_name, +group_name +FROM awscc.iam.group_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/group_policy/index.md b/docs/awscc-docs/providers/awscc/iam/group_policy/index.md new file mode 100644 index 0000000000..294231f490 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/group_policy/index.md @@ -0,0 +1,69 @@ +--- +title: group_policy +hide_title: false +hide_table_of_contents: false +keywords: + - group_policy + - 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 +--- +Gets an individual group_policy resource + +## Overview + + + + + +
Namegroup_policy
TypeResource
Descriptiongroup_policy
Idawscc.iam.group_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
policy_documentobjectThe policy document.<br/> 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.<br/> 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:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
policy_namestringThe name of the policy document.<br/> 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: _+=,.@-
group_namestringThe name of the group to associate the policy with.<br/> 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: _+=,.@-.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group_policy resource, the following permissions are required: + +### Read +
+iam:GetGroupPolicy
+ +### Update +
+iam:PutGroupPolicy,
+iam:GetGroupPolicy
+ +### Delete +
+iam:DeleteGroupPolicy,
+iam:GetGroupPolicy
+ + +## Example +```sql +SELECT +region, +policy_document, +policy_name, +group_name +FROM awscc.iam.group_policy +WHERE data__Identifier = '<PolicyName>' +AND data__Identifier = '<GroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/groups/index.md b/docs/awscc-docs/providers/awscc/iam/groups/index.md new file mode 100644 index 0000000000..1cb1c9de18 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/groups/index.md @@ -0,0 +1,62 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - groups + - 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 +--- +Retrieves a list of groups in a region + +## Overview + + + + + +
Namegroups
TypeResource
Descriptiongroups
Idawscc.iam.groups
+ +## Fields + + + + + +
NameDatatypeDescription
group_namestringThe name of the group to create
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +
+iam:CreateGroup,
+iam:PutGroupPolicy,
+iam:AttachGroupPolicy,
+iam:GetGroupPolicy,
+iam:GetGroup
+ +### List +
+iam:ListGroups
+ + +## Example +```sql +SELECT +region, +group_name +FROM awscc.iam.groups + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/index.md b/docs/awscc-docs/providers/awscc/iam/index.md new file mode 100644 index 0000000000..4b6ee80535 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/index.md @@ -0,0 +1,63 @@ +--- +title: iam +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iam service documentation. + +:::info Service Summary + +
+
+total resources: 26
+total selectable resources: 26
+total methods: 26
+
+
+ +::: + +## Resources +
+
+group
+group_policies
+group_policy
+groups
+instance_profile
+instance_profiles
+managed_policies
+managed_policy
+oidc_provider
+oidc_providers
+role
+role_policies
+role_policy +
+
+roles
+saml_provider
+saml_providers
+server_certificate
+server_certificates
+service_linked_role
+service_linked_roles
+user
+user_policies
+user_policy
+users
+virtualmfa_device
+virtualmfa_devices +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iam/instance_profile/index.md b/docs/awscc-docs/providers/awscc/iam/instance_profile/index.md new file mode 100644 index 0000000000..edc9815f0d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/instance_profile/index.md @@ -0,0 +1,73 @@ +--- +title: instance_profile +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profile + - 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 +--- +Gets an individual instance_profile resource + +## Overview + + + + + +
Nameinstance_profile
TypeResource
Descriptioninstance_profile
Idawscc.iam.instance_profile
+ +## Fields + + + + + + + + +
NameDatatypeDescription
pathstringThe 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*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> 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.
rolesarrayThe 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.
instance_profile_namestringThe name of the instance profile to create.<br/> 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: _+=,.@-
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_profile resource, the following permissions are required: + +### Read +
+iam:GetInstanceProfile
+ +### Update +
+iam:PassRole,
+iam:RemoveRoleFromInstanceProfile,
+iam:AddRoleToInstanceProfile,
+iam:GetInstanceProfile
+ +### Delete +
+iam:GetInstanceProfile,
+iam:RemoveRoleFromInstanceProfile,
+iam:DeleteInstanceProfile
+ + +## Example +```sql +SELECT +region, +path, +roles, +instance_profile_name, +arn +FROM awscc.iam.instance_profile +WHERE data__Identifier = '<InstanceProfileName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md b/docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md new file mode 100644 index 0000000000..9524b21c57 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md @@ -0,0 +1,61 @@ +--- +title: instance_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles + - 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 +--- +Retrieves a list of instance_profiles in a region + +## Overview + + + + + +
Nameinstance_profiles
TypeResource
Descriptioninstance_profiles
Idawscc.iam.instance_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
instance_profile_namestringThe name of the instance profile to create.<br/> 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: _+=,.@-
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_profiles resource, the following permissions are required: + +### Create +
+iam:CreateInstanceProfile,
+iam:PassRole,
+iam:AddRoleToInstanceProfile,
+iam:GetInstanceProfile
+ +### List +
+iam:ListInstanceProfiles
+ + +## Example +```sql +SELECT +region, +instance_profile_name +FROM awscc.iam.instance_profiles + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/managed_policies/index.md b/docs/awscc-docs/providers/awscc/iam/managed_policies/index.md new file mode 100644 index 0000000000..cefefb42ad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/managed_policies/index.md @@ -0,0 +1,61 @@ +--- +title: managed_policies +hide_title: false +hide_table_of_contents: false +keywords: + - managed_policies + - 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 +--- +Retrieves a list of managed_policies in a region + +## Overview + + + + + +
Namemanaged_policies
TypeResource
Descriptionmanaged_policies
Idawscc.iam.managed_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_arnstringAmazon Resource Name (ARN) of the managed policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the managed_policies resource, the following permissions are required: + +### Create +
+iam:CreatePolicy,
+iam:AttachGroupPolicy,
+iam:AttachUserPolicy,
+iam:AttachRolePolicy
+ +### List +
+iam:ListPolicies
+ + +## Example +```sql +SELECT +region, +policy_arn +FROM awscc.iam.managed_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/managed_policy/index.md b/docs/awscc-docs/providers/awscc/iam/managed_policy/index.md new file mode 100644 index 0000000000..fd0219ac3b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/managed_policy/index.md @@ -0,0 +1,108 @@ +--- +title: managed_policy +hide_title: false +hide_table_of_contents: false +keywords: + - managed_policy + - 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 +--- +Gets an individual managed_policy resource + +## Overview + + + + + +
Namemanaged_policy
TypeResource
Descriptionmanaged_policy
Idawscc.iam.managed_policy
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA friendly description of the policy.
groupsarrayThe name (friendly name, not ARN) of the group to attach the policy to.
managed_policy_namestringThe friendly name of the policy.
pathstringThe path for the policy.
policy_documentobjectThe JSON policy document that you want to use as the content for the new policy.
rolesarrayThe name (friendly name, not ARN) of the role to attach the policy to.
usersarrayThe name (friendly name, not ARN) of the IAM user to attach the policy to.
policy_arnstringAmazon Resource Name (ARN) of the managed policy
attachment_countintegerThe number of entities (users, groups, and roles) that the policy is attached to.
create_datestringThe date and time, in ISO 8601 date-time format, when the policy was created.
update_datestringThe date and time, in ISO 8601 date-time format, when the policy was last updated.
default_version_idstringThe identifier for the version of the policy that is set as the default version.
is_attachablebooleanSpecifies whether the policy can be attached to an IAM user, group, or role.
permissions_boundary_usage_countintegerThe number of entities (users and roles) for which the policy is used to set the permissions boundary.
policy_idstringThe stable and unique string identifying the policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the managed_policy resource, the following permissions are required: + +### Read +
+iam:GetPolicy,
+iam:ListEntitiesForPolicy,
+iam:GetPolicyVersion
+ +### Update +
+iam:DetachRolePolicy,
+iam:GetPolicy,
+iam:ListPolicyVersions,
+iam:DetachGroupPolicy,
+iam:DetachUserPolicy,
+iam:CreatePolicyVersion,
+iam:DeletePolicyVersion,
+iam:AttachGroupPolicy,
+iam:AttachUserPolicy,
+iam:AttachRolePolicy
+ +### Delete +
+iam:DetachRolePolicy,
+iam:GetPolicy,
+iam:ListPolicyVersions,
+iam:DetachGroupPolicy,
+iam:DetachUserPolicy,
+iam:DeletePolicyVersion,
+iam:DeletePolicy,
+iam:ListEntitiesForPolicy
+ + +## Example +```sql +SELECT +region, +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 awscc.iam.managed_policy +WHERE data__Identifier = '<PolicyArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md b/docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md new file mode 100644 index 0000000000..ff3573f6a7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md @@ -0,0 +1,76 @@ +--- +title: oidc_provider +hide_title: false +hide_table_of_contents: false +keywords: + - oidc_provider + - 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 +--- +Gets an individual oidc_provider resource + +## Overview + + + + + +
Nameoidc_provider
TypeResource
Descriptionoidc_provider
Idawscc.iam.oidc_provider
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
client_id_listarray
urlstring
thumbprint_listarray
arnstringAmazon Resource Name (ARN) of the OIDC provider
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the oidc_provider resource, the following permissions are required: + +### Read +
+iam:GetOpenIDConnectProvider
+ +### Update +
+iam:UpdateOpenIDConnectProviderThumbprint,
+iam:RemoveClientIDFromOpenIDConnectProvider,
+iam:AddClientIDToOpenIDConnectProvider,
+iam:GetOpenIDConnectProvider,
+iam:TagOpenIDConnectProvider,
+iam:UntagOpenIDConnectProvider,
+iam:ListOpenIDConnectProviderTags
+ +### Delete +
+iam:DeleteOpenIDConnectProvider
+ + +## Example +```sql +SELECT +region, +client_id_list, +url, +thumbprint_list, +arn, +tags +FROM awscc.iam.oidc_provider +WHERE data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md b/docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md new file mode 100644 index 0000000000..651cf1e236 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md @@ -0,0 +1,61 @@ +--- +title: oidc_providers +hide_title: false +hide_table_of_contents: false +keywords: + - oidc_providers + - 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 +--- +Retrieves a list of oidc_providers in a region + +## Overview + + + + + +
Nameoidc_providers
TypeResource
Descriptionoidc_providers
Idawscc.iam.oidc_providers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the OIDC provider
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the oidc_providers resource, the following permissions are required: + +### Create +
+iam:CreateOpenIDConnectProvider,
+iam:TagOpenIDConnectProvider,
+iam:GetOpenIDConnectProvider
+ +### List +
+iam:ListOpenIDConnectProvider,
+iam:GetOpenIDConnectProvider
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.iam.oidc_providers + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/role/index.md b/docs/awscc-docs/providers/awscc/iam/role/index.md new file mode 100644 index 0000000000..132a287219 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/role/index.md @@ -0,0 +1,102 @@ +--- +title: role +hide_title: false +hide_table_of_contents: false +keywords: + - role + - 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 +--- +Gets an individual role resource + +## Overview + + + + + +
Namerole
TypeResource
Descriptionrole
Idawscc.iam.role
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
assume_role_policy_documentobjectThe 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*.
descriptionstringA description of the role that you provide.
managed_policy_arnsarrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.<br/> 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*.
max_session_durationintegerThe 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.<br/> 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*.
pathstringThe 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*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> 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.
permissions_boundarystringThe ARN of the policy used to set the permissions boundary for the role.<br/> 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*.
policiesarrayAdds or updates an inline policy document that is embedded in the specified IAM role.<br/> 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).<br/> 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*.<br/> 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*.<br/> If an external policy (such as ``AWS::IAM::Policy`` or
role_idstring
role_namestringA 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*.<br/> 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".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.<br/> 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
tagsarrayA 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*.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the role resource, the following permissions are required: + +### Read +
+iam:GetRole,
+iam:ListAttachedRolePolicies,
+iam:ListRolePolicies,
+iam:GetRolePolicy
+ +### Update +
+iam:UpdateRole,
+iam:UpdateRoleDescription,
+iam:UpdateAssumeRolePolicy,
+iam:DetachRolePolicy,
+iam:AttachRolePolicy,
+iam:DeleteRolePermissionsBoundary,
+iam:PutRolePermissionsBoundary,
+iam:DeleteRolePolicy,
+iam:PutRolePolicy,
+iam:TagRole,
+iam:UntagRole
+ +### Delete +
+iam:DeleteRole,
+iam:DetachRolePolicy,
+iam:DeleteRolePolicy,
+iam:GetRole,
+iam:ListAttachedRolePolicies,
+iam:ListRolePolicies,
+iam:TagRole,
+iam:UntagRole
+ + +## Example +```sql +SELECT +region, +arn, +assume_role_policy_document, +description, +managed_policy_arns, +max_session_duration, +path, +permissions_boundary, +policies, +role_id, +role_name, +tags +FROM awscc.iam.role +WHERE data__Identifier = '<RoleName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/role_policies/index.md b/docs/awscc-docs/providers/awscc/iam/role_policies/index.md new file mode 100644 index 0000000000..0213328325 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/role_policies/index.md @@ -0,0 +1,57 @@ +--- +title: role_policies +hide_title: false +hide_table_of_contents: false +keywords: + - role_policies + - 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 +--- +Retrieves a list of role_policies in a region + +## Overview + + + + + +
Namerole_policies
TypeResource
Descriptionrole_policies
Idawscc.iam.role_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_namestringThe name of the policy document.<br/> 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: _+=,.@-
role_namestringThe name of the role to associate the policy with.<br/> 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: _+=,.@-
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the role_policies resource, the following permissions are required: + +### Create +
+iam:PutRolePolicy,
+iam:GetRolePolicy
+ + +## Example +```sql +SELECT +region, +policy_name, +role_name +FROM awscc.iam.role_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/role_policy/index.md b/docs/awscc-docs/providers/awscc/iam/role_policy/index.md new file mode 100644 index 0000000000..b4f40762af --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/role_policy/index.md @@ -0,0 +1,69 @@ +--- +title: role_policy +hide_title: false +hide_table_of_contents: false +keywords: + - role_policy + - 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 +--- +Gets an individual role_policy resource + +## Overview + + + + + +
Namerole_policy
TypeResource
Descriptionrole_policy
Idawscc.iam.role_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
policy_documentobjectThe policy document.<br/> 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.<br/> 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:<br/> + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range<br/> + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``)<br/> + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``)
policy_namestringThe name of the policy document.<br/> 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: _+=,.@-
role_namestringThe name of the role to associate the policy with.<br/> 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: _+=,.@-
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the role_policy resource, the following permissions are required: + +### Read +
+iam:GetRolePolicy
+ +### Update +
+iam:PutRolePolicy,
+iam:GetRolePolicy
+ +### Delete +
+iam:DeleteRolePolicy,
+iam:GetRolePolicy
+ + +## Example +```sql +SELECT +region, +policy_document, +policy_name, +role_name +FROM awscc.iam.role_policy +WHERE data__Identifier = '<PolicyName>' +AND data__Identifier = '<RoleName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/roles/index.md b/docs/awscc-docs/providers/awscc/iam/roles/index.md new file mode 100644 index 0000000000..f8cb612698 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/roles/index.md @@ -0,0 +1,64 @@ +--- +title: roles +hide_title: false +hide_table_of_contents: false +keywords: + - roles + - 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 +--- +Retrieves a list of roles in a region + +## Overview + + + + + +
Nameroles
TypeResource
Descriptionroles
Idawscc.iam.roles
+ +## Fields + + + + + +
NameDatatypeDescription
role_namestringA 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*.<br/> 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".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.<br/> 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
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the roles resource, the following permissions are required: + +### Create +
+iam:CreateRole,
+iam:PutRolePolicy,
+iam:AttachRolePolicy,
+iam:GetRolePolicy,
+iam:TagRole,
+iam:UntagRole,
+iam:GetRole
+ +### List +
+iam:ListRoles
+ + +## Example +```sql +SELECT +region, +role_name +FROM awscc.iam.roles + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/saml_provider/index.md b/docs/awscc-docs/providers/awscc/iam/saml_provider/index.md new file mode 100644 index 0000000000..14e46573ea --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/saml_provider/index.md @@ -0,0 +1,72 @@ +--- +title: saml_provider +hide_title: false +hide_table_of_contents: false +keywords: + - saml_provider + - 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 +--- +Gets an individual saml_provider resource + +## Overview + + + + + +
Namesaml_provider
TypeResource
Descriptionsaml_provider
Idawscc.iam.saml_provider
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestring
saml_metadata_documentstring
arnstringAmazon Resource Name (ARN) of the SAML provider
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the saml_provider resource, the following permissions are required: + +### Read +
+iam:GetSAMLProvider
+ +### Update +
+iam:UpdateSAMLProvider,
+iam:GetSAMLProvider,
+iam:TagSAMLProvider,
+iam:ListSAMLProviderTags,
+iam:UntagSAMLProvider
+ +### Delete +
+iam:DeleteSAMLProvider
+ + +## Example +```sql +SELECT +region, +name, +saml_metadata_document, +arn, +tags +FROM awscc.iam.saml_provider +WHERE data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/saml_providers/index.md b/docs/awscc-docs/providers/awscc/iam/saml_providers/index.md new file mode 100644 index 0000000000..88e049495b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/saml_providers/index.md @@ -0,0 +1,61 @@ +--- +title: saml_providers +hide_title: false +hide_table_of_contents: false +keywords: + - saml_providers + - 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 +--- +Retrieves a list of saml_providers in a region + +## Overview + + + + + +
Namesaml_providers
TypeResource
Descriptionsaml_providers
Idawscc.iam.saml_providers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the SAML provider
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the saml_providers resource, the following permissions are required: + +### Create +
+iam:CreateSAMLProvider,
+iam:GetSAMLProvider,
+iam:TagSAMLProvider
+ +### List +
+iam:ListSAMLProviders,
+iam:GetSAMLProvider
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.iam.saml_providers + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/server_certificate/index.md b/docs/awscc-docs/providers/awscc/iam/server_certificate/index.md new file mode 100644 index 0000000000..63c7697482 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/server_certificate/index.md @@ -0,0 +1,77 @@ +--- +title: server_certificate +hide_title: false +hide_table_of_contents: false +keywords: + - server_certificate + - 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 +--- +Gets an individual server_certificate resource + +## Overview + + + + + +
Nameserver_certificate
TypeResource
Descriptionserver_certificate
Idawscc.iam.server_certificate
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
certificate_bodystring
certificate_chainstring
server_certificate_namestring
pathstring
private_keystring
arnstringAmazon Resource Name (ARN) of the server certificate
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the server_certificate resource, the following permissions are required: + +### Read +
+iam:GetServerCertificate
+ +### Update +
+iam:TagServerCertificate,
+iam:UntagServerCertificate,
+iam:ListServerCertificateTags,
+iam:GetServerCertificate
+ +### Delete +
+iam:DeleteServerCertificate
+ + +## Example +```sql +SELECT +region, +certificate_body, +certificate_chain, +server_certificate_name, +path, +private_key, +arn, +tags +FROM awscc.iam.server_certificate +WHERE data__Identifier = '<ServerCertificateName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/server_certificates/index.md b/docs/awscc-docs/providers/awscc/iam/server_certificates/index.md new file mode 100644 index 0000000000..8958414dcd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/server_certificates/index.md @@ -0,0 +1,61 @@ +--- +title: server_certificates +hide_title: false +hide_table_of_contents: false +keywords: + - server_certificates + - 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 +--- +Retrieves a list of server_certificates in a region + +## Overview + + + + + +
Nameserver_certificates
TypeResource
Descriptionserver_certificates
Idawscc.iam.server_certificates
+ +## Fields + + + + + +
NameDatatypeDescription
server_certificate_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the server_certificates resource, the following permissions are required: + +### Create +
+iam:UploadServerCertificate,
+iam:TagServerCertificate,
+iam:GetServerCertificate
+ +### List +
+iam:ListServerCertificates,
+iam:GetServerCertificate
+ + +## Example +```sql +SELECT +region, +server_certificate_name +FROM awscc.iam.server_certificates + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/service_linked_role/index.md b/docs/awscc-docs/providers/awscc/iam/service_linked_role/index.md new file mode 100644 index 0000000000..43675023ae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/service_linked_role/index.md @@ -0,0 +1,71 @@ +--- +title: service_linked_role +hide_title: false +hide_table_of_contents: false +keywords: + - service_linked_role + - 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 +--- +Gets an individual service_linked_role resource + +## Overview + + + + + +
Nameservice_linked_role
TypeResource
Descriptionservice_linked_role
Idawscc.iam.service_linked_role
+ +## Fields + + + + + + + + +
NameDatatypeDescription
role_namestringThe name of the role.
custom_suffixstringA string that you provide, which is combined with the service-provided prefix to form the complete role name.
descriptionstringThe description of the role.
a_ws_service_namestringThe service principal for the AWS service to which this role is attached.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_linked_role resource, the following permissions are required: + +### Read +
+iam:GetRole
+ +### Update +
+iam:UpdateRole,
+iam:GetRole
+ +### Delete +
+iam:DeleteServiceLinkedRole,
+iam:GetServiceLinkedRoleDeletionStatus,
+iam:GetRole
+ + +## Example +```sql +SELECT +region, +role_name, +custom_suffix, +description, +a_ws_service_name +FROM awscc.iam.service_linked_role +WHERE data__Identifier = '<RoleName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/service_linked_roles/index.md b/docs/awscc-docs/providers/awscc/iam/service_linked_roles/index.md new file mode 100644 index 0000000000..b58148185b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/service_linked_roles/index.md @@ -0,0 +1,55 @@ +--- +title: service_linked_roles +hide_title: false +hide_table_of_contents: false +keywords: + - service_linked_roles + - 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 +--- +Retrieves a list of service_linked_roles in a region + +## Overview + + + + + +
Nameservice_linked_roles
TypeResource
Descriptionservice_linked_roles
Idawscc.iam.service_linked_roles
+ +## Fields + + + + + +
NameDatatypeDescription
role_namestringThe name of the role.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_linked_roles resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+iam:GetRole
+ + +## Example +```sql +SELECT +region, +role_name +FROM awscc.iam.service_linked_roles + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/user/index.md b/docs/awscc-docs/providers/awscc/iam/user/index.md new file mode 100644 index 0000000000..147aa70646 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/user/index.md @@ -0,0 +1,111 @@ +--- +title: user +hide_title: false +hide_table_of_contents: false +keywords: + - user + - 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 +--- +Gets an individual user resource + +## Overview + + + + + +
Nameuser
TypeResource
Descriptionuser
Idawscc.iam.user
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
pathstringThe 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*.<br/> This parameter is optional. If it is not included, it defaults to a slash (/).<br/> 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.
managed_policy_arnsarrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.<br/> 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*.
policiesarrayAdds 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).<br/> 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. <br/> 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*.
user_namestringThe name of the user to create. Do not include the path in this value.<br/> 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".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.<br/> 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).<br/> 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"}]]}``.
groupsarrayA list of group names to which you want to add the user.
arnstring
login_profileobjectCreates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.<br/> 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.<br/> For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
tagsarrayA 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*.<br/> 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.
permissions_boundarystringThe ARN of the managed policy that is used to set the permissions boundary for the user.<br/> 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*.<br/> 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*.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +
+iam:GetUserPolicy,
+iam:ListGroupsForUser,
+iam:ListAttachedUserPolicies,
+iam:ListUserPolicies,
+iam:GetUser,
+iam:GetLoginProfile
+ +### Update +
+iam:UpdateLoginProfile,
+iam:UpdateUser,
+iam:PutUserPermissionsBoundary,
+iam:AttachUserPolicy,
+iam:DeleteUserPolicy,
+iam:DeleteUserPermissionsBoundary,
+iam:TagUser,
+iam:UntagUser,
+iam:CreateLoginProfile,
+iam:RemoveUserFromGroup,
+iam:AddUserToGroup,
+iam:PutUserPolicy,
+iam:DetachUserPolicy,
+iam:GetLoginProfile,
+iam:DeleteLoginProfile,
+iam:GetUser,
+iam:ListUserTags
+ +### Delete +
+iam:DeleteAccessKey,
+iam:RemoveUserFromGroup,
+iam:DeleteUserPolicy,
+iam:DeleteUser,
+iam:DetachUserPolicy,
+iam:DeleteLoginProfile,
+iam:ListAccessKeys,
+iam:GetUserPolicy,
+iam:ListGroupsForUser,
+iam:ListAttachedUserPolicies,
+iam:ListUserPolicies,
+iam:GetUser,
+iam:GetLoginProfile
+ + +## Example +```sql +SELECT +region, +path, +managed_policy_arns, +policies, +user_name, +groups, +arn, +login_profile, +tags, +permissions_boundary +FROM awscc.iam.user +WHERE data__Identifier = '<UserName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/user_policies/index.md b/docs/awscc-docs/providers/awscc/iam/user_policies/index.md new file mode 100644 index 0000000000..139956b5aa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/user_policies/index.md @@ -0,0 +1,57 @@ +--- +title: user_policies +hide_title: false +hide_table_of_contents: false +keywords: + - user_policies + - 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 +--- +Retrieves a list of user_policies in a region + +## Overview + + + + + +
Nameuser_policies
TypeResource
Descriptionuser_policies
Idawscc.iam.user_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_namestringThe name of the policy document.
user_namestringThe name of the user to associate the policy with.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_policies resource, the following permissions are required: + +### Create +
+iam:PutUserPolicy,
+iam:GetUserPolicy
+ + +## Example +```sql +SELECT +region, +policy_name, +user_name +FROM awscc.iam.user_policies + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/user_policy/index.md b/docs/awscc-docs/providers/awscc/iam/user_policy/index.md new file mode 100644 index 0000000000..93f365da3a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/user_policy/index.md @@ -0,0 +1,69 @@ +--- +title: user_policy +hide_title: false +hide_table_of_contents: false +keywords: + - user_policy + - 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 +--- +Gets an individual user_policy resource + +## Overview + + + + + +
Nameuser_policy
TypeResource
Descriptionuser_policy
Idawscc.iam.user_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
policy_documentobjectThe policy document.
policy_namestringThe name of the policy document.
user_namestringThe name of the user to associate the policy with.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_policy resource, the following permissions are required: + +### Read +
+iam:GetUserPolicy
+ +### Update +
+iam:PutUserPolicy,
+iam:GetUserPolicy
+ +### Delete +
+iam:DeleteUserPolicy,
+iam:GetUserPolicy
+ + +## Example +```sql +SELECT +region, +policy_document, +policy_name, +user_name +FROM awscc.iam.user_policy +WHERE data__Identifier = '<PolicyName>' +AND data__Identifier = '<UserName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/users/index.md b/docs/awscc-docs/providers/awscc/iam/users/index.md new file mode 100644 index 0000000000..a5e99343ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/users/index.md @@ -0,0 +1,64 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - 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 +--- +Retrieves a list of users in a region + +## Overview + + + + + +
Nameusers
TypeResource
Descriptionusers
Idawscc.iam.users
+ +## Fields + + + + + +
NameDatatypeDescription
user_namestringThe name of the user to create. Do not include the path in this value.<br/> 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".<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.<br/> 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).<br/> 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"}]]}``.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +
+iam:CreateLoginProfile,
+iam:AddUserToGroup,
+iam:PutUserPolicy,
+iam:AttachUserPolicy,
+iam:CreateUser,
+iam:GetUser,
+iam:TagUser
+ +### List +
+iam:listUsers
+ + +## Example +```sql +SELECT +region, +user_name +FROM awscc.iam.users + +``` diff --git a/docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md b/docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md new file mode 100644 index 0000000000..0ae56224b2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md @@ -0,0 +1,72 @@ +--- +title: virtualmfa_device +hide_title: false +hide_table_of_contents: false +keywords: + - virtualmfa_device + - 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 +--- +Gets an individual virtualmfa_device resource + +## Overview + + + + + +
Namevirtualmfa_device
TypeResource
Descriptionvirtualmfa_device
Idawscc.iam.virtualmfa_device
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
virtual_mfa_device_namestring
pathstring
serial_numberstring
usersarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the virtualmfa_device resource, the following permissions are required: + +### Read +
+iam:ListVirtualMFADevices
+ +### Update +
+iam:TagMFADevice,
+iam:UntagMFADevice
+ +### Delete +
+iam:DeleteVirtualMFADevice,
+iam:DeactivateMFADevice
+ + +## Example +```sql +SELECT +region, +virtual_mfa_device_name, +path, +serial_number, +users, +tags +FROM awscc.iam.virtualmfa_device +WHERE data__Identifier = '<SerialNumber>' +``` diff --git a/docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md b/docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md new file mode 100644 index 0000000000..22a18ee577 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md @@ -0,0 +1,60 @@ +--- +title: virtualmfa_devices +hide_title: false +hide_table_of_contents: false +keywords: + - virtualmfa_devices + - 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 +--- +Retrieves a list of virtualmfa_devices in a region + +## Overview + + + + + +
Namevirtualmfa_devices
TypeResource
Descriptionvirtualmfa_devices
Idawscc.iam.virtualmfa_devices
+ +## Fields + + + + + +
NameDatatypeDescription
serial_numberstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the virtualmfa_devices resource, the following permissions are required: + +### Create +
+iam:CreateVirtualMFADevice,
+iam:EnableMFADevice,
+iam:ListVirtualMFADevices
+ +### List +
+iam:ListVirtualMFADevices
+ + +## Example +```sql +SELECT +region, +serial_number +FROM awscc.iam.virtualmfa_devices + +``` diff --git a/docs/awscc-docs/providers/awscc/identitystore/group/index.md b/docs/awscc-docs/providers/awscc/identitystore/group/index.md new file mode 100644 index 0000000000..1d108ef1e4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/identitystore/group/index.md @@ -0,0 +1,72 @@ +--- +title: group +hide_title: false +hide_table_of_contents: false +keywords: + - group + - 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 +--- +Gets an individual group resource + +## Overview + + + + + +
Namegroup
TypeResource
Descriptiongroup
Idawscc.identitystore.group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringA string containing the description of the group.
display_namestringA string containing the name of the group. This value is commonly displayed when the group is referenced.
group_idstringThe unique identifier for a group in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +
+identitystore:DescribeGroup
+ +### Update +
+identitystore:DescribeGroup,
+identitystore:UpdateGroup
+ +### Delete +
+identitystore:DescribeGroup,
+identitystore:DeleteGroup
+ + +## Example +```sql +SELECT +region, +description, +display_name, +group_id, +identity_store_id +FROM awscc.identitystore.group +WHERE region = 'us-east-1' +AND data__Identifier = '<GroupId>' +AND data__Identifier = '<IdentityStoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md b/docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md new file mode 100644 index 0000000000..badb5db1a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md @@ -0,0 +1,67 @@ +--- +title: group_membership +hide_title: false +hide_table_of_contents: false +keywords: + - group_membership + - 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 +--- +Gets an individual group_membership resource + +## Overview + + + + + +
Namegroup_membership
TypeResource
Descriptiongroup_membership
Idawscc.identitystore.group_membership
+ +## Fields + + + + + + + + +
NameDatatypeDescription
group_idstringThe unique identifier for a group in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
member_idobjectAn object containing the identifier of a group member.
membership_idstringThe identifier for a GroupMembership in the identity store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group_membership resource, the following permissions are required: + +### Read +
+identitystore:DescribeGroupMembership
+ +### Delete +
+identitystore:DeleteGroupMembership,
+identitystore:DescribeGroupMembership
+ + +## Example +```sql +SELECT +region, +group_id, +identity_store_id, +member_id, +membership_id +FROM awscc.identitystore.group_membership +WHERE region = 'us-east-1' +AND data__Identifier = '<MembershipId>' +AND data__Identifier = '<IdentityStoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md b/docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md new file mode 100644 index 0000000000..e86d28c969 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md @@ -0,0 +1,61 @@ +--- +title: group_memberships +hide_title: false +hide_table_of_contents: false +keywords: + - group_memberships + - 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 +--- +Retrieves a list of group_memberships in a region + +## Overview + + + + + +
Namegroup_memberships
TypeResource
Descriptiongroup_memberships
Idawscc.identitystore.group_memberships
+ +## Fields + + + + + + +
NameDatatypeDescription
membership_idstringThe identifier for a GroupMembership in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group_memberships resource, the following permissions are required: + +### Create +
+identitystore:CreateGroupMembership,
+identitystore:DescribeGroupMembership
+ +### List +
+identitystore:ListGroupMemberships
+ + +## Example +```sql +SELECT +region, +membership_id, +identity_store_id +FROM awscc.identitystore.group_memberships +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/identitystore/groups/index.md b/docs/awscc-docs/providers/awscc/identitystore/groups/index.md new file mode 100644 index 0000000000..86b0683892 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/identitystore/groups/index.md @@ -0,0 +1,61 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - groups + - 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 +--- +Retrieves a list of groups in a region + +## Overview + + + + + +
Namegroups
TypeResource
Descriptiongroups
Idawscc.identitystore.groups
+ +## Fields + + + + + + +
NameDatatypeDescription
group_idstringThe unique identifier for a group in the identity store.
identity_store_idstringThe globally unique identifier for the identity store.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +
+identitystore:CreateGroup,
+identitystore:DescribeGroup
+ +### List +
+identitystore:ListGroups
+ + +## Example +```sql +SELECT +region, +group_id, +identity_store_id +FROM awscc.identitystore.groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/identitystore/index.md b/docs/awscc-docs/providers/awscc/identitystore/index.md new file mode 100644 index 0000000000..37ff252a26 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/identitystore/index.md @@ -0,0 +1,41 @@ +--- +title: identitystore +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The identitystore service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+group
+group_membership +
+
+group_memberships
+groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/component/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/component/index.md new file mode 100644 index 0000000000..0d5edc6940 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/component/index.md @@ -0,0 +1,85 @@ +--- +title: component +hide_title: false +hide_table_of_contents: false +keywords: + - component + - 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 +--- +Gets an individual component resource + +## Overview + + + + + +
Namecomponent
TypeResource
Descriptioncomponent
Idawscc.imagebuilder.component
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the component.
namestringThe name of the component.
versionstringThe version of the component.
descriptionstringThe description of the component.
change_descriptionstringThe change description of the component.
typestringThe type of the component denotes whether the component is used to build the image or only to test it.
platformstringThe platform of the component.
datastringThe data of the component.
kms_key_idstringThe KMS key identifier used to encrypt the component.
encryptedbooleanThe encryption status of the component.
tagsobjectThe tags associated with the component.
uristringThe uri of the component.
supported_os_versionsarrayThe operating system (OS) version supported by the component.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the component resource, the following permissions are required: + +### Read +
+imagebuilder:GetComponent
+ +### Delete +
+imagebuilder:GetComponent,
+imagebuilder:UnTagResource,
+imagebuilder:DeleteComponent
+ + +## Example +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +platform, +data, +kms_key_id, +encrypted, +tags, +uri, +supported_os_versions +FROM awscc.imagebuilder.component +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/components/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/components/index.md new file mode 100644 index 0000000000..fe4dd58dcf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/components/index.md @@ -0,0 +1,68 @@ +--- +title: components +hide_title: false +hide_table_of_contents: false +keywords: + - components + - 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 +--- +Retrieves a list of components in a region + +## Overview + + + + + +
Namecomponents
TypeResource
Descriptioncomponents
Idawscc.imagebuilder.components
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the component.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the components resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+iam:GetRole,
+kms:GenerateDataKey*,
+kms:Encrypt,
+kms:Decrypt,
+s3:GetObject,
+s3:HeadBucket,
+s3:GetBucketLocation,
+imagebuilder:TagResource,
+imagebuilder:GetComponent,
+imagebuilder:CreateComponent
+ +### List +
+imagebuilder:ListComponents
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.components +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md new file mode 100644 index 0000000000..c4e46c82fc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md @@ -0,0 +1,91 @@ +--- +title: container_recipe +hide_title: false +hide_table_of_contents: false +keywords: + - container_recipe + - 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 +--- +Gets an individual container_recipe resource + +## Overview + + + + + +
Namecontainer_recipe
TypeResource
Descriptioncontainer_recipe
Idawscc.imagebuilder.container_recipe
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the container recipe.
namestringThe name of the container recipe.
descriptionstringThe description of the container recipe.
versionstringThe semantic version of the container recipe (<major>.<minor>.<patch>).
componentsarrayComponents for build and test that are included in the container recipe.
instance_configurationobjectA group of options that can be used to configure an instance for building and testing container images.
dockerfile_template_datastringDockerfiles 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.
dockerfile_template_uristringThe S3 URI for the Dockerfile that will be used to build your container image.
platform_overridestringSpecifies the operating system platform when you use a custom source image.
container_typestringSpecifies the type of container, such as Docker.
image_os_version_overridestringSpecifies the operating system version for the source image.
target_repositoryobjectThe destination repository for the container image.
kms_key_idstringIdentifies which KMS key is used to encrypt the container image.
parent_imagestringThe source image for the container recipe.
working_directorystringThe working directory to be used during build and test workflows.
tagsobjectTags that are attached to the container recipe.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the container_recipe resource, the following permissions are required: + +### Read +
+imagebuilder:GetContainerRecipe
+ +### Delete +
+imagebuilder:UnTagResource,
+imagebuilder:GetContainerRecipe,
+imagebuilder:DeleteContainerRecipe
+ + +## Example +```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, +tags +FROM awscc.imagebuilder.container_recipe +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md new file mode 100644 index 0000000000..d83edf50c7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md @@ -0,0 +1,73 @@ +--- +title: container_recipes +hide_title: false +hide_table_of_contents: false +keywords: + - container_recipes + - 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 +--- +Retrieves a list of container_recipes in a region + +## Overview + + + + + +
Namecontainer_recipes
TypeResource
Descriptioncontainer_recipes
Idawscc.imagebuilder.container_recipes
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the container recipe.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the container_recipes resource, the following permissions are required: + +### Create +
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+imagebuilder:GetComponent,
+imagebuilder:TagResource,
+imagebuilder:GetContainerRecipe,
+imagebuilder:CreateContainerRecipe,
+imagebuilder:GetImage,
+kms:Encrypt,
+kms:Decrypt,
+kms:ReEncryptFrom,
+kms:ReEncryptTo,
+kms:GenerateDataKey*,
+s3:GetObject,
+s3:ListBucket,
+ecr:DescribeRepositories,
+ec2:DescribeImages
+ +### List +
+imagebuilder:ListContainerRecipes
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.container_recipes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md new file mode 100644 index 0000000000..21ab3c5080 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md @@ -0,0 +1,77 @@ +--- +title: distribution_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_configuration + - 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 +--- +Gets an individual distribution_configuration resource + +## Overview + + + + + +
Namedistribution_configuration
TypeResource
Descriptiondistribution_configuration
Idawscc.imagebuilder.distribution_configuration
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
namestringThe name of the distribution configuration.
descriptionstringThe description of the distribution configuration.
distributionsarrayThe distributions of the distribution configuration.
tagsobjectThe tags associated with the component.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the distribution_configuration resource, the following permissions are required: + +### Update +
+ec2:DescribeLaunchTemplates,
+ec2:CreateLaunchTemplateVersion,
+ec2:ModifyLaunchTemplate,
+imagebuilder:GetDistributionConfiguration,
+imagebuilder:UpdateDistributionConfiguration
+ +### Read +
+imagebuilder:GetDistributionConfiguration
+ +### Delete +
+imagebuilder:GetDistributionConfiguration,
+imagebuilder:UnTagResource,
+imagebuilder:DeleteDistributionConfiguration
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +distributions, +tags +FROM awscc.imagebuilder.distribution_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md new file mode 100644 index 0000000000..cbcad6093a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md @@ -0,0 +1,65 @@ +--- +title: distribution_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_configurations + - 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 +--- +Retrieves a list of distribution_configurations in a region + +## Overview + + + + + +
Namedistribution_configurations
TypeResource
Descriptiondistribution_configurations
Idawscc.imagebuilder.distribution_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the distribution_configurations resource, the following permissions are required: + +### Create +
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+ec2:DescribeLaunchTemplates,
+ec2:CreateLaunchTemplateVersion,
+ec2:ModifyLaunchTemplate,
+imagebuilder:TagResource,
+imagebuilder:GetDistributionConfiguration,
+imagebuilder:CreateDistributionConfiguration
+ +### List +
+imagebuilder:ListDistributionConfigurations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.distribution_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image/index.md new file mode 100644 index 0000000000..cc4c924ee2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/image/index.md @@ -0,0 +1,88 @@ +--- +title: image +hide_title: false +hide_table_of_contents: false +keywords: + - image + - 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 +--- +Gets an individual image resource + +## Overview + + + + + +
Nameimage
TypeResource
Descriptionimage
Idawscc.imagebuilder.image
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image.
namestringThe name of the image.
image_tests_configurationobjectThe image tests configuration used when creating this image.
image_recipe_arnstringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
container_recipe_arnstringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distribution_configuration_arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
infrastructure_configuration_arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
workflowsarrayWorkflows to define the image build process
image_idstringThe AMI ID of the EC2 AMI in current region.
image_uristringURI for containers created in current Region with default ECR image tag
enhanced_image_metadata_enabledbooleanCollects additional information about the image being created, including the operating system (OS) version and package list.
image_scanning_configurationobjectContains settings for vulnerability scans.
execution_rolestringThe execution role name/ARN for the image build, if provided
tagsobjectThe tags associated with the image.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image resource, the following permissions are required: + +### Read +
+imagebuilder:GetImage
+ +### Delete +
+imagebuilder:GetImage,
+imagebuilder:DeleteImage,
+imagebuilder:UnTagResource,
+imagebuilder:CancelImageCreation
+ + +## Example +```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, +tags +FROM awscc.imagebuilder.image +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md new file mode 100644 index 0000000000..16e39eda25 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md @@ -0,0 +1,96 @@ +--- +title: image_pipeline +hide_title: false +hide_table_of_contents: false +keywords: + - image_pipeline + - 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 +--- +Gets an individual image_pipeline resource + +## Overview + + + + + +
Nameimage_pipeline
TypeResource
Descriptionimage_pipeline
Idawscc.imagebuilder.image_pipeline
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image pipeline.
namestringThe name of the image pipeline.
descriptionstringThe description of the image pipeline.
image_tests_configurationobjectThe image tests configuration of the image pipeline.
statusstringThe status of the image pipeline.
scheduleobjectThe schedule of the image pipeline.
image_recipe_arnstringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
container_recipe_arnstringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distribution_configuration_arnstringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
infrastructure_configuration_arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
workflowsarrayWorkflows to define the image build process
enhanced_image_metadata_enabledbooleanCollects additional information about the image being created, including the operating system (OS) version and package list.
image_scanning_configurationobjectContains settings for vulnerability scans.
execution_rolestringThe execution role name/ARN for the image build, if provided
tagsobjectThe tags of this image pipeline.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_pipeline resource, the following permissions are required: + +### Update +
+iam:PassRole,
+imagebuilder:GetImagePipeline,
+imagebuilder:UpdateImagePipeline,
+imagebuilder:GetWorkflow
+ +### Read +
+imagebuilder:GetImagePipeline
+ +### Delete +
+imagebuilder:UnTagResource,
+imagebuilder:GetImagePipeline,
+imagebuilder:DeleteImagePipeline
+ + +## Example +```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, +tags +FROM awscc.imagebuilder.image_pipeline +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md new file mode 100644 index 0000000000..9fa008f57b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md @@ -0,0 +1,69 @@ +--- +title: image_pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - image_pipelines + - 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 +--- +Retrieves a list of image_pipelines in a region + +## Overview + + + + + +
Nameimage_pipelines
TypeResource
Descriptionimage_pipelines
Idawscc.imagebuilder.image_pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image pipeline.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_pipelines resource, the following permissions are required: + +### Create +
+ecr:BatchGetRepositoryScanningConfiguration,
+iam:GetRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+imagebuilder:TagResource,
+imagebuilder:GetImagePipeline,
+imagebuilder:GetImageRecipe,
+imagebuilder:GetInfrastructureConfiguration,
+imagebuilder:GetDistributionConfiguration,
+imagebuilder:CreateImagePipeline,
+imagebuilder:GetWorkflow,
+inspector2:BatchGetAccountStatus
+ +### List +
+imagebuilder:ListImagePipelines
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.image_pipelines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md new file mode 100644 index 0000000000..88d1548d44 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md @@ -0,0 +1,79 @@ +--- +title: image_recipe +hide_title: false +hide_table_of_contents: false +keywords: + - image_recipe + - 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 +--- +Gets an individual image_recipe resource + +## Overview + + + + + +
Nameimage_recipe
TypeResource
Descriptionimage_recipe
Idawscc.imagebuilder.image_recipe
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image recipe.
namestringThe name of the image recipe.
descriptionstringThe description of the image recipe.
versionstringThe version of the image recipe.
componentsarrayThe components of the image recipe.
block_device_mappingsarrayThe block device mappings to apply when creating images from this recipe.
parent_imagestringThe parent image of the image recipe.
working_directorystringThe working directory to be used during build and test workflows.
additional_instance_configurationobjectSpecify additional settings and launch scripts for your build instances.
tagsobjectThe tags of the image recipe.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_recipe resource, the following permissions are required: + +### Read +
+imagebuilder:GetImageRecipe
+ +### Delete +
+imagebuilder:UnTagResource,
+imagebuilder:GetImageRecipe,
+imagebuilder:DeleteImageRecipe
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +version, +components, +block_device_mappings, +parent_image, +working_directory, +additional_instance_configuration, +tags +FROM awscc.imagebuilder.image_recipe +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md new file mode 100644 index 0000000000..8cdda54102 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md @@ -0,0 +1,65 @@ +--- +title: image_recipes +hide_title: false +hide_table_of_contents: false +keywords: + - image_recipes + - 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 +--- +Retrieves a list of image_recipes in a region + +## Overview + + + + + +
Nameimage_recipes
TypeResource
Descriptionimage_recipes
Idawscc.imagebuilder.image_recipes
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image recipe.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_recipes resource, the following permissions are required: + +### Create +
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+imagebuilder:GetComponent,
+imagebuilder:GetImage,
+imagebuilder:TagResource,
+imagebuilder:GetImageRecipe,
+imagebuilder:CreateImageRecipe,
+ec2:DescribeImages
+ +### List +
+imagebuilder:ListImageRecipes
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.image_recipes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/images/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/images/index.md new file mode 100644 index 0000000000..d528cf00e3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/images/index.md @@ -0,0 +1,69 @@ +--- +title: images +hide_title: false +hide_table_of_contents: false +keywords: + - images + - 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 +--- +Retrieves a list of images in a region + +## Overview + + + + + +
Nameimages
TypeResource
Descriptionimages
Idawscc.imagebuilder.images
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the images resource, the following permissions are required: + +### Create +
+ecr:BatchGetRepositoryScanningConfiguration,
+iam:GetRole,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+imagebuilder:GetImageRecipe,
+imagebuilder:GetInfrastructureConfiguration,
+imagebuilder:GetDistributionConfiguration,
+imagebuilder:GetWorkflow,
+imagebuilder:GetImage,
+imagebuilder:CreateImage,
+imagebuilder:TagResource,
+inspector2:BatchGetAccountStatus
+ +### List +
+imagebuilder:ListImages
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.images +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/index.md new file mode 100644 index 0000000000..9e8923744e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/index.md @@ -0,0 +1,55 @@ +--- +title: imagebuilder +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The imagebuilder service documentation. + +:::info Service Summary + +
+
+total resources: 18
+total selectable resources: 18
+total methods: 18
+
+
+ +::: + +## Resources +
+
+component
+components
+container_recipe
+container_recipes
+distribution_configuration
+distribution_configurations
+image
+image_pipeline
+image_pipelines +
+
+image_recipe
+image_recipes
+images
+infrastructure_configuration
+infrastructure_configurations
+lifecycle_policies
+lifecycle_policy
+workflow
+workflows +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configuration/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configuration/index.md new file mode 100644 index 0000000000..2fa0a44c2f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configuration/index.md @@ -0,0 +1,94 @@ +--- +title: infrastructure_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - infrastructure_configuration + - 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 +--- +Gets an individual infrastructure_configuration resource + +## Overview + + + + + +
Nameinfrastructure_configuration
TypeResource
Descriptioninfrastructure_configuration
Idawscc.imagebuilder.infrastructure_configuration
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
namestringThe name of the infrastructure configuration.
descriptionstringThe description of the infrastructure configuration.
instance_typesarrayThe instance types of the infrastructure configuration.
security_group_idsarrayThe security group IDs of the infrastructure configuration.
loggingobjectThe logging configuration of the infrastructure configuration.
subnet_idstringThe subnet ID of the infrastructure configuration.
key_pairstringThe EC2 key pair of the infrastructure configuration..
terminate_instance_on_failurebooleanThe terminate instance on failure configuration of the infrastructure configuration.
instance_profile_namestringThe instance profile of the infrastructure configuration.
instance_metadata_optionsobjectThe instance metadata option settings for the infrastructure configuration.
sns_topic_arnstringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
resource_tagsobjectThe tags attached to the resource created by Image Builder.
tagsobjectThe tags associated with the component.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the infrastructure_configuration resource, the following permissions are required: + +### Update +
+iam:PassRole,
+sns:Publish,
+imagebuilder:GetInfrastructureConfiguration,
+imagebuilder:UpdateInfrastructureConfiguration
+ +### Read +
+imagebuilder:GetInfrastructureConfiguration
+ +### Delete +
+imagebuilder:UnTagResource,
+imagebuilder:GetInfrastructureConfiguration,
+imagebuilder:DeleteInfrastructureConfiguration
+ + +## Example +```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, +tags +FROM awscc.imagebuilder.infrastructure_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md new file mode 100644 index 0000000000..f970c0f4a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md @@ -0,0 +1,65 @@ +--- +title: infrastructure_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - infrastructure_configurations + - 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 +--- +Retrieves a list of infrastructure_configurations in a region + +## Overview + + + + + +
Nameinfrastructure_configurations
TypeResource
Descriptioninfrastructure_configurations
Idawscc.imagebuilder.infrastructure_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the infrastructure_configurations resource, the following permissions are required: + +### Create +
+iam:PassRole,
+iam:GetRole,
+iam:GetInstanceProfile,
+iam:CreateServiceLinkedRole,
+sns:Publish,
+imagebuilder:TagResource,
+imagebuilder:GetInfrastructureConfiguration,
+imagebuilder:CreateInfrastructureConfiguration
+ +### List +
+imagebuilder:ListInfrastructureConfigurations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.infrastructure_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md new file mode 100644 index 0000000000..7ab00c0de0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md @@ -0,0 +1,61 @@ +--- +title: lifecycle_policies +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policies + - 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 +--- +Retrieves a list of lifecycle_policies in a region + +## Overview + + + + + +
Namelifecycle_policies
TypeResource
Descriptionlifecycle_policies
Idawscc.imagebuilder.lifecycle_policies
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the lifecycle policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the lifecycle_policies resource, the following permissions are required: + +### Create +
+iam:PassRole,
+imagebuilder:CreateLifecyclePolicy,
+imagebuilder:GetLifecyclePolicy,
+imagebuilder:TagResource
+ +### List +
+imagebuilder:ListLifecyclePolicies
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.lifecycle_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md new file mode 100644 index 0000000000..dc99e4d363 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md @@ -0,0 +1,83 @@ +--- +title: lifecycle_policy +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policy + - 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 +--- +Gets an individual lifecycle_policy resource + +## Overview + + + + + +
Namelifecycle_policy
TypeResource
Descriptionlifecycle_policy
Idawscc.imagebuilder.lifecycle_policy
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the lifecycle policy.
namestringThe name of the lifecycle policy.
descriptionstringThe description of the lifecycle policy.
statusstringThe status of the lifecycle policy.
execution_rolestringThe execution role of the lifecycle policy.
resource_typestringThe resource type of the lifecycle policy.
policy_detailsarrayThe policy details of the lifecycle policy.
resource_selectionobjectThe resource selection of the lifecycle policy.
tagsobjectThe tags associated with the lifecycle policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the lifecycle_policy resource, the following permissions are required: + +### Update +
+iam:PassRole,
+imagebuilder:GetLifecyclePolicy,
+imagebuilder:UpdateLifecyclePolicy
+ +### Read +
+imagebuilder:GetLifecyclePolicy
+ +### Delete +
+imagebuilder:GetLifecyclePolicy,
+imagebuilder:DeleteLifecyclePolicy,
+imagebuilder:UnTagResource
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +status, +execution_role, +resource_type, +policy_details, +resource_selection, +tags +FROM awscc.imagebuilder.lifecycle_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md new file mode 100644 index 0000000000..e5785b1a93 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md @@ -0,0 +1,79 @@ +--- +title: workflow +hide_title: false +hide_table_of_contents: false +keywords: + - workflow + - 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 +--- +Gets an individual workflow resource + +## Overview + + + + + +
Nameworkflow
TypeResource
Descriptionworkflow
Idawscc.imagebuilder.workflow
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the workflow.
namestringThe name of the workflow.
versionstringThe version of the workflow.
descriptionstringThe description of the workflow.
change_descriptionstringThe change description of the workflow.
typestringThe type of the workflow denotes whether the workflow is used to build, test, or distribute.
datastringThe data of the workflow.
uristringThe uri of the workflow.
kms_key_idstringThe KMS key identifier used to encrypt the workflow.
tagsobjectThe tags associated with the workflow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workflow resource, the following permissions are required: + +### Read +
+imagebuilder:GetWorkflow
+ +### Delete +
+imagebuilder:GetWorkflow,
+imagebuilder:UnTagResource,
+imagebuilder:DeleteWorkflow
+ + +## Example +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +data, +uri, +kms_key_id, +tags +FROM awscc.imagebuilder.workflow +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md new file mode 100644 index 0000000000..515bc86488 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md @@ -0,0 +1,67 @@ +--- +title: workflows +hide_title: false +hide_table_of_contents: false +keywords: + - workflows + - 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 +--- +Retrieves a list of workflows in a region + +## Overview + + + + + +
Nameworkflows
TypeResource
Descriptionworkflows
Idawscc.imagebuilder.workflows
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the workflow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +
+iam:GetRole,
+kms:GenerateDataKey*,
+kms:Encrypt,
+kms:Decrypt,
+s3:GetObject,
+s3:HeadBucket,
+s3:GetBucketLocation,
+imagebuilder:TagResource,
+imagebuilder:GetWorkflow,
+imagebuilder:CreateWorkflow
+ +### List +
+imagebuilder:ListWorkflows
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.imagebuilder.workflows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md new file mode 100644 index 0000000000..58d772621d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md @@ -0,0 +1,68 @@ +--- +title: assessment_target +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_target + - 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 +--- +Gets an individual assessment_target resource + +## Overview + + + + + +
Nameassessment_target
TypeResource
Descriptionassessment_target
Idawscc.inspector.assessment_target
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
assessment_target_namestring
resource_group_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assessment_target resource, the following permissions are required: + +### Update +
+inspector:DescribeAssessmentTargets,
+inspector:UpdateAssessmentTarget
+ +### Read +
+inspector:DescribeAssessmentTargets
+ +### Delete +
+inspector:DeleteAssessmentTarget
+ + +## Example +```sql +SELECT +region, +arn, +assessment_target_name, +resource_group_arn +FROM awscc.inspector.assessment_target +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md new file mode 100644 index 0000000000..61a4c94e9c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md @@ -0,0 +1,60 @@ +--- +title: assessment_targets +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_targets + - 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 +--- +Retrieves a list of assessment_targets in a region + +## Overview + + + + + +
Nameassessment_targets
TypeResource
Descriptionassessment_targets
Idawscc.inspector.assessment_targets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assessment_targets resource, the following permissions are required: + +### Create +
+inspector:CreateAssessmentTarget,
+inspector:ListAssessmentTargets,
+inspector:DescribeAssessmentTargets
+ +### List +
+inspector:ListAssessmentTargets
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.inspector.assessment_targets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md new file mode 100644 index 0000000000..33b8368f3f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md @@ -0,0 +1,69 @@ +--- +title: assessment_template +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_template + - 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 +--- +Gets an individual assessment_template resource + +## Overview + + + + + +
Nameassessment_template
TypeResource
Descriptionassessment_template
Idawscc.inspector.assessment_template
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
assessment_target_arnstring
duration_in_secondsinteger
assessment_template_namestring
rules_package_arnsarray
user_attributes_for_findingsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assessment_template resource, the following permissions are required: + +### Read +
+inspector:DescribeAssessmentTemplates
+ +### Delete +
+inspector:DeleteAssessmentTemplate
+ + +## Example +```sql +SELECT +region, +arn, +assessment_target_arn, +duration_in_seconds, +assessment_template_name, +rules_package_arns, +user_attributes_for_findings +FROM awscc.inspector.assessment_template +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md new file mode 100644 index 0000000000..77513f7f8a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md @@ -0,0 +1,60 @@ +--- +title: assessment_templates +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_templates + - 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 +--- +Retrieves a list of assessment_templates in a region + +## Overview + + + + + +
Nameassessment_templates
TypeResource
Descriptionassessment_templates
Idawscc.inspector.assessment_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assessment_templates resource, the following permissions are required: + +### Create +
+inspector:CreateAssessmentTemplate,
+inspector:ListAssessmentTemplates,
+inspector:DescribeAssessmentTemplates
+ +### List +
+inspector:ListAssessmentTemplates
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.inspector.assessment_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/inspector/index.md b/docs/awscc-docs/providers/awscc/inspector/index.md new file mode 100644 index 0000000000..b7f011fe73 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspector/index.md @@ -0,0 +1,43 @@ +--- +title: inspector +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The inspector service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+assessment_target
+assessment_targets
+assessment_template +
+
+assessment_templates
+resource_group
+resource_groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/inspector/resource_group/index.md b/docs/awscc-docs/providers/awscc/inspector/resource_group/index.md new file mode 100644 index 0000000000..45df4b37b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspector/resource_group/index.md @@ -0,0 +1,61 @@ +--- +title: resource_group +hide_title: false +hide_table_of_contents: false +keywords: + - resource_group + - 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 +--- +Gets an individual resource_group resource + +## Overview + + + + + +
Nameresource_group
TypeResource
Descriptionresource_group
Idawscc.inspector.resource_group
+ +## Fields + + + + + + +
NameDatatypeDescription
arnstring
resource_group_tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_group resource, the following permissions are required: + +### Read +
+inspector:CreateResourceGroup
+ +### Delete +
+inspector:CreateResourceGroup
+ + +## Example +```sql +SELECT +region, +arn, +resource_group_tags +FROM awscc.inspector.resource_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/inspector/resource_groups/index.md b/docs/awscc-docs/providers/awscc/inspector/resource_groups/index.md new file mode 100644 index 0000000000..b304f8a413 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspector/resource_groups/index.md @@ -0,0 +1,54 @@ +--- +title: resource_groups +hide_title: false +hide_table_of_contents: false +keywords: + - resource_groups + - 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 +--- +Retrieves a list of resource_groups in a region + +## Overview + + + + + +
Nameresource_groups
TypeResource
Descriptionresource_groups
Idawscc.inspector.resource_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_groups resource, the following permissions are required: + +### Create +
+inspector:CreateResourceGroup
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.inspector.resource_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configuration/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configuration/index.md new file mode 100644 index 0000000000..c0b1d8b15c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configuration/index.md @@ -0,0 +1,80 @@ +--- +title: cis_scan_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - cis_scan_configuration + - 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 +--- +Gets an individual cis_scan_configuration resource + +## Overview + + + + + +
Namecis_scan_configuration
TypeResource
Descriptioncis_scan_configuration
Idawscc.inspectorv2.cis_scan_configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
scan_namestringName of the scan
security_levelstring
scheduleundefined
targetsundefined
arnstringCIS Scan configuration unique identifier
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cis_scan_configuration resource, the following permissions are required: + +### Read +
+inspector2:ListCisScanConfigurations,
+inspector2:ListTagsForResource
+ +### Update +
+inspector2:ListCisScanConfigurations,
+inspector2:UpdateCisScanConfiguration,
+inspector2:TagResource,
+inspector2:UntagResource,
+inspector2:ListTagsForResource
+ +### Delete +
+inspector2:ListCisScanConfigurations,
+inspector2:DeleteCisScanConfiguration,
+inspector2:UntagResource
+ + +## Example +```sql +SELECT +region, +scan_name, +security_level, +schedule, +targets, +arn, +tags +FROM awscc.inspectorv2.cis_scan_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configurations/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configurations/index.md new file mode 100644 index 0000000000..035e9e65d5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configurations/index.md @@ -0,0 +1,61 @@ +--- +title: cis_scan_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - cis_scan_configurations + - 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 +--- +Retrieves a list of cis_scan_configurations in a region + +## Overview + + + + + +
Namecis_scan_configurations
TypeResource
Descriptioncis_scan_configurations
Idawscc.inspectorv2.cis_scan_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringCIS Scan configuration unique identifier
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cis_scan_configurations resource, the following permissions are required: + +### Create +
+inspector2:CreateCisScanConfiguration,
+inspector2:ListCisScanConfigurations,
+inspector2:TagResource
+ +### List +
+inspector2:ListCisScanConfigurations,
+inspector2:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.inspectorv2.cis_scan_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md new file mode 100644 index 0000000000..b3fbe18ab2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md @@ -0,0 +1,73 @@ +--- +title: filter +hide_title: false +hide_table_of_contents: false +keywords: + - filter + - 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 +--- +Gets an individual filter resource + +## Overview + + + + + +
Namefilter
TypeResource
Descriptionfilter
Idawscc.inspectorv2.filter
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringFindings filter name.
descriptionstringFindings filter description.
filter_criteriaobjectFindings filter criteria.
filter_actionstringFindings filter action.
arnstringFindings filter ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the filter resource, the following permissions are required: + +### Read +
+inspector2:ListFilters
+ +### Update +
+inspector2:ListFilters,
+inspector2:UpdateFilter
+ +### Delete +
+inspector2:DeleteFilter,
+inspector2:ListFilters
+ + +## Example +```sql +SELECT +region, +name, +description, +filter_criteria, +filter_action, +arn +FROM awscc.inspectorv2.filter +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md new file mode 100644 index 0000000000..b1e30997e0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md @@ -0,0 +1,59 @@ +--- +title: filters +hide_title: false +hide_table_of_contents: false +keywords: + - filters + - 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 +--- +Retrieves a list of filters in a region + +## Overview + + + + + +
Namefilters
TypeResource
Descriptionfilters
Idawscc.inspectorv2.filters
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringFindings filter ARN.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the filters resource, the following permissions are required: + +### Create +
+inspector2:CreateFilter,
+inspector2:ListFilters
+ +### List +
+inspector2:ListFilters
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.inspectorv2.filters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/index.md new file mode 100644 index 0000000000..10b99c3b69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/inspectorv2/index.md @@ -0,0 +1,41 @@ +--- +title: inspectorv2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The inspectorv2 service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+cis_scan_configuration
+cis_scan_configurations +
+
+filter
+filters +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/internetmonitor/index.md b/docs/awscc-docs/providers/awscc/internetmonitor/index.md new file mode 100644 index 0000000000..c959a8d368 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/internetmonitor/index.md @@ -0,0 +1,39 @@ +--- +title: internetmonitor +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The internetmonitor service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+monitor +
+
+monitors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/internetmonitor/monitor/index.md b/docs/awscc-docs/providers/awscc/internetmonitor/monitor/index.md new file mode 100644 index 0000000000..4ed3844eb0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/internetmonitor/monitor/index.md @@ -0,0 +1,109 @@ +--- +title: monitor +hide_title: false +hide_table_of_contents: false +keywords: + - monitor + - 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 +--- +Gets an individual monitor resource + +## Overview + + + + + +
Namemonitor
TypeResource
Descriptionmonitor
Idawscc.internetmonitor.monitor
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
created_atstring
modified_atstring
monitor_arnstring
monitor_namestring
processing_statusstring
processing_status_infostring
resourcesarray
resources_to_addarray
resources_to_removearray
statusstring
tagsarray
max_city_networks_to_monitorinteger
traffic_percentage_to_monitorinteger
internet_measurements_log_deliveryobject
health_events_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the monitor resource, the following permissions are required: + +### Read +
+internetmonitor:GetMonitor,
+internetmonitor:ListTagsForResource,
+logs:GetLogDelivery
+ +### Update +
+internetmonitor:CreateMonitor,
+internetmonitor:GetMonitor,
+internetmonitor:UpdateMonitor,
+internetmonitor:TagResource,
+internetmonitor:UntagResource,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+s3:ListBucket,
+iam:PassRole
+ +### Delete +
+internetmonitor:UpdateMonitor,
+internetmonitor:DeleteMonitor,
+internetmonitor:GetMonitor,
+logs:DeleteLogDelivery
+ + +## Example +```sql +SELECT +region, +created_at, +modified_at, +monitor_arn, +monitor_name, +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 awscc.internetmonitor.monitor +WHERE region = 'us-east-1' +AND data__Identifier = '<MonitorName>' +``` diff --git a/docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md b/docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md new file mode 100644 index 0000000000..3a07827386 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md @@ -0,0 +1,69 @@ +--- +title: monitors +hide_title: false +hide_table_of_contents: false +keywords: + - monitors + - 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 +--- +Retrieves a list of monitors in a region + +## Overview + + + + + +
Namemonitors
TypeResource
Descriptionmonitors
Idawscc.internetmonitor.monitors
+ +## Fields + + + + + +
NameDatatypeDescription
monitor_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the monitors resource, the following permissions are required: + +### Create +
+internetmonitor:CreateMonitor,
+internetmonitor:GetMonitor,
+internetmonitor:TagResource,
+internetmonitor:UntagResource,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+s3:ListBucket,
+iam:PassRole
+ +### List +
+internetmonitor:ListMonitors,
+internetmonitor:GetMonitor,
+logs:GetLogDelivery
+ + +## Example +```sql +SELECT +region, +monitor_name +FROM awscc.internetmonitor.monitors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/account_audit_configuration/index.md b/docs/awscc-docs/providers/awscc/iot/account_audit_configuration/index.md new file mode 100644 index 0000000000..64e84cac5f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/account_audit_configuration/index.md @@ -0,0 +1,72 @@ +--- +title: account_audit_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - account_audit_configuration + - 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 +--- +Gets an individual account_audit_configuration resource + +## Overview + + + + + +
Nameaccount_audit_configuration
TypeResource
Descriptionaccount_audit_configuration
Idawscc.iot.account_audit_configuration
+ +## Fields + + + + + + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
audit_check_configurationsobject
audit_notification_target_configurationsobject
role_arnstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account_audit_configuration resource, the following permissions are required: + +### Read +
+iot:DescribeAccountAuditConfiguration
+ +### Update +
+iot:UpdateAccountAuditConfiguration,
+iot:DescribeAccountAuditConfiguration,
+iam:PassRole
+ +### Delete +
+iot:DescribeAccountAuditConfiguration,
+iot:DeleteAccountAuditConfiguration
+ + +## Example +```sql +SELECT +region, +account_id, +audit_check_configurations, +audit_notification_target_configurations, +role_arn +FROM awscc.iot.account_audit_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/account_audit_configurations/index.md b/docs/awscc-docs/providers/awscc/iot/account_audit_configurations/index.md new file mode 100644 index 0000000000..d3f648fca9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/account_audit_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: account_audit_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - account_audit_configurations + - 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 +--- +Retrieves a list of account_audit_configurations in a region + +## Overview + + + + + +
Nameaccount_audit_configurations
TypeResource
Descriptionaccount_audit_configurations
Idawscc.iot.account_audit_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account_audit_configurations resource, the following permissions are required: + +### Create +
+iot:UpdateAccountAuditConfiguration,
+iot:DescribeAccountAuditConfiguration,
+iam:PassRole
+ +### List +
+iot:DescribeAccountAuditConfiguration
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.iot.account_audit_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/authorizer/index.md b/docs/awscc-docs/providers/awscc/iot/authorizer/index.md new file mode 100644 index 0000000000..aca22d8b8d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/authorizer/index.md @@ -0,0 +1,86 @@ +--- +title: authorizer +hide_title: false +hide_table_of_contents: false +keywords: + - authorizer + - 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 +--- +Gets an individual authorizer resource + +## Overview + + + + + +
Nameauthorizer
TypeResource
Descriptionauthorizer
Idawscc.iot.authorizer
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
authorizer_function_arnstring
arnstring
authorizer_namestring
signing_disabledboolean
statusstring
token_key_namestring
token_signing_public_keysobject
enable_caching_for_httpboolean
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the authorizer resource, the following permissions are required: + +### Read +
+iot:DescribeAuthorizer,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateAuthorizer,
+iot:DescribeAuthorizer,
+iot:TagResource,
+iot:UntagResource,
+iot:ListTagsForResource
+ +### Delete +
+iot:UpdateAuthorizer,
+iot:DeleteAuthorizer,
+iot:DescribeAuthorizer
+ + +## Example +```sql +SELECT +region, +authorizer_function_arn, +arn, +authorizer_name, +signing_disabled, +status, +token_key_name, +token_signing_public_keys, +enable_caching_for_http, +tags +FROM awscc.iot.authorizer +WHERE region = 'us-east-1' +AND data__Identifier = '<AuthorizerName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/authorizers/index.md b/docs/awscc-docs/providers/awscc/iot/authorizers/index.md new file mode 100644 index 0000000000..afdf489ecb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/authorizers/index.md @@ -0,0 +1,61 @@ +--- +title: authorizers +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers + - 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 +--- +Retrieves a list of authorizers in a region + +## Overview + + + + + +
Nameauthorizers
TypeResource
Descriptionauthorizers
Idawscc.iot.authorizers
+ +## Fields + + + + + +
NameDatatypeDescription
authorizer_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +
+iot:CreateAuthorizer,
+iot:DescribeAuthorizer,
+iot:TagResource,
+iot:ListTagsForResource
+ +### List +
+iot:ListAuthorizers
+ + +## Example +```sql +SELECT +region, +authorizer_name +FROM awscc.iot.authorizers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/billing_group/index.md b/docs/awscc-docs/providers/awscc/iot/billing_group/index.md new file mode 100644 index 0000000000..cc7650be2b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/billing_group/index.md @@ -0,0 +1,77 @@ +--- +title: billing_group +hide_title: false +hide_table_of_contents: false +keywords: + - billing_group + - 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 +--- +Gets an individual billing_group resource + +## Overview + + + + + +
Namebilling_group
TypeResource
Descriptionbilling_group
Idawscc.iot.billing_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
billing_group_namestring
tagsarrayAn array of key-value pairs to apply to this resource.
billing_group_propertiesobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the billing_group resource, the following permissions are required: + +### Delete +
+iot:DescribeBillingGroup,
+iot:DeleteBillingGroup
+ +### Read +
+iot:DescribeBillingGroup,
+iot:ListTagsForResource
+ +### Update +
+iot:DescribeBillingGroup,
+iot:UpdateBillingGroup,
+iot:ListTagsForResource,
+iot:TagResource,
+iot:UntagResource
+ + +## Example +```sql +SELECT +region, +id, +arn, +billing_group_name, +tags, +billing_group_properties +FROM awscc.iot.billing_group +WHERE region = 'us-east-1' +AND data__Identifier = '<BillingGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/billing_groups/index.md b/docs/awscc-docs/providers/awscc/iot/billing_groups/index.md new file mode 100644 index 0000000000..4cfef56557 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/billing_groups/index.md @@ -0,0 +1,62 @@ +--- +title: billing_groups +hide_title: false +hide_table_of_contents: false +keywords: + - billing_groups + - 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 +--- +Retrieves a list of billing_groups in a region + +## Overview + + + + + +
Namebilling_groups
TypeResource
Descriptionbilling_groups
Idawscc.iot.billing_groups
+ +## Fields + + + + + +
NameDatatypeDescription
billing_group_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the billing_groups resource, the following permissions are required: + +### Create +
+iot:DescribeBillingGroup,
+iot:ListTagsForResource,
+iot:CreateBillingGroup,
+iot:TagResource
+ +### List +
+iot:ListBillingGroups,
+iot:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +billing_group_name +FROM awscc.iot.billing_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md b/docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md new file mode 100644 index 0000000000..2175f6b3d6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md @@ -0,0 +1,90 @@ +--- +title: ca_certificate +hide_title: false +hide_table_of_contents: false +keywords: + - ca_certificate + - 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 +--- +Gets an individual ca_certificate resource + +## Overview + + + + + +
Nameca_certificate
TypeResource
Descriptionca_certificate
Idawscc.iot.ca_certificate
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
c_acertificate_pemstring
verification_certificate_pemstringThe private key verification certificate.
statusstring
certificate_modestring
auto_registration_statusstring
remove_auto_registrationboolean
registration_configobject
idstring
arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ca_certificate resource, the following permissions are required: + +### Read +
+iot:DescribeCACertificate,
+iot:ListTagsForResource
+ +### Update +
+iam:GetRole,
+iam:PassRole,
+iot:UpdateCACertificate,
+iot:DescribeCACertificate,
+iot:TagResource,
+iot:UntagResource,
+iot:ListTagsForResource
+ +### Delete +
+iot:UpdateCACertificate,
+iot:DeleteCACertificate,
+iot:DescribeCACertificate
+ + +## Example +```sql +SELECT +region, +c_acertificate_pem, +verification_certificate_pem, +status, +certificate_mode, +auto_registration_status, +remove_auto_registration, +registration_config, +id, +arn, +tags +FROM awscc.iot.ca_certificate +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md b/docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md new file mode 100644 index 0000000000..e96f138fb3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md @@ -0,0 +1,63 @@ +--- +title: ca_certificates +hide_title: false +hide_table_of_contents: false +keywords: + - ca_certificates + - 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 +--- +Retrieves a list of ca_certificates in a region + +## Overview + + + + + +
Nameca_certificates
TypeResource
Descriptionca_certificates
Idawscc.iot.ca_certificates
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ca_certificates resource, the following permissions are required: + +### Create +
+iam:GetRole,
+iam:PassRole,
+iot:RegisterCACertificate,
+iot:DescribeCACertificate,
+iot:TagResource,
+iot:ListTagsForResource
+ +### List +
+iot:ListCACertificates
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iot.ca_certificates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/certificate/index.md b/docs/awscc-docs/providers/awscc/iot/certificate/index.md new file mode 100644 index 0000000000..1d121fc5f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/certificate/index.md @@ -0,0 +1,78 @@ +--- +title: certificate +hide_title: false +hide_table_of_contents: false +keywords: + - certificate + - 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 +--- +Gets an individual certificate resource + +## Overview + + + + + +
Namecertificate
TypeResource
Descriptioncertificate
Idawscc.iot.certificate
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
c_acertificate_pemstring
certificate_pemstring
certificate_signing_requeststring
certificate_modestring
statusstring
idstring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +
+iot:DescribeCertificate
+ +### Update +
+iot:UpdateCertificate,
+iot:DescribeCertificate
+ +### Delete +
+iot:DeleteCertificate,
+iot:UpdateCertificate,
+iot:DescribeCertificate
+ + +## Example +```sql +SELECT +region, +c_acertificate_pem, +certificate_pem, +certificate_signing_request, +certificate_mode, +status, +id, +arn +FROM awscc.iot.certificate +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md b/docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md new file mode 100644 index 0000000000..b320dc8702 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md @@ -0,0 +1,77 @@ +--- +title: certificate_provider +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_provider + - 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 +--- +Gets an individual certificate_provider resource + +## Overview + + + + + +
Namecertificate_provider
TypeResource
Descriptioncertificate_provider
Idawscc.iot.certificate_provider
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
certificate_provider_namestring
lambda_function_arnstring
account_default_for_operationsarray
tagsarrayAn array of key-value pairs to apply to this resource.
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate_provider resource, the following permissions are required: + +### Read +
+iot:DescribeCertificateProvider,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateCertificateProvider,
+iot:DescribeCertificateProvider,
+iot:TagResource,
+iot:UntagResource,
+iot:ListTagsForResource
+ +### Delete +
+iot:DeleteCertificateProvider,
+iot:DescribeCertificateProvider
+ + +## Example +```sql +SELECT +region, +certificate_provider_name, +lambda_function_arn, +account_default_for_operations, +tags, +arn +FROM awscc.iot.certificate_provider +WHERE region = 'us-east-1' +AND data__Identifier = '<CertificateProviderName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md b/docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md new file mode 100644 index 0000000000..1a0c42cfd2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md @@ -0,0 +1,61 @@ +--- +title: certificate_providers +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_providers + - 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 +--- +Retrieves a list of certificate_providers in a region + +## Overview + + + + + +
Namecertificate_providers
TypeResource
Descriptioncertificate_providers
Idawscc.iot.certificate_providers
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_provider_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate_providers resource, the following permissions are required: + +### Create +
+iot:CreateCertificateProvider,
+iot:DescribeCertificateProvider,
+iot:TagResource,
+iot:ListTagsForResource
+ +### List +
+iot:ListCertificateProviders
+ + +## Example +```sql +SELECT +region, +certificate_provider_name +FROM awscc.iot.certificate_providers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/certificates/index.md b/docs/awscc-docs/providers/awscc/iot/certificates/index.md new file mode 100644 index 0000000000..8e82849a9c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/certificates/index.md @@ -0,0 +1,61 @@ +--- +title: certificates +hide_title: false +hide_table_of_contents: false +keywords: + - certificates + - 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 +--- +Retrieves a list of certificates in a region + +## Overview + + + + + +
Namecertificates
TypeResource
Descriptioncertificates
Idawscc.iot.certificates
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +
+iot:CreateCertificateFromCsr,
+iot:RegisterCertificate,
+iot:RegisterCertificateWithoutCA,
+iot:DescribeCertificate
+ +### List +
+iot:ListCertificates
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iot.certificates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/custom_metric/index.md b/docs/awscc-docs/providers/awscc/iot/custom_metric/index.md new file mode 100644 index 0000000000..8f25aca3e7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/custom_metric/index.md @@ -0,0 +1,76 @@ +--- +title: custom_metric +hide_title: false +hide_table_of_contents: false +keywords: + - custom_metric + - 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 +--- +Gets an individual custom_metric resource + +## Overview + + + + + +
Namecustom_metric
TypeResource
Descriptioncustom_metric
Idawscc.iot.custom_metric
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
metric_namestringThe 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.
display_namestringField 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.
metric_typestringThe type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
metric_arnstringThe Amazon Resource Number (ARN) of the custom metric.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_metric resource, the following permissions are required: + +### Read +
+iot:DescribeCustomMetric,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateCustomMetric,
+iot:ListTagsForResource,
+iot:UntagResource,
+iot:TagResource
+ +### Delete +
+iot:DescribeCustomMetric,
+iot:DeleteCustomMetric
+ + +## Example +```sql +SELECT +region, +metric_name, +display_name, +metric_type, +metric_arn, +tags +FROM awscc.iot.custom_metric +WHERE region = 'us-east-1' +AND data__Identifier = '<MetricName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md b/docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md new file mode 100644 index 0000000000..990fed95ee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md @@ -0,0 +1,59 @@ +--- +title: custom_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - custom_metrics + - 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 +--- +Retrieves a list of custom_metrics in a region + +## Overview + + + + + +
Namecustom_metrics
TypeResource
Descriptioncustom_metrics
Idawscc.iot.custom_metrics
+ +## Fields + + + + + +
NameDatatypeDescription
metric_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_metrics resource, the following permissions are required: + +### Create +
+iot:CreateCustomMetric,
+iot:TagResource
+ +### List +
+iot:ListCustomMetrics
+ + +## Example +```sql +SELECT +region, +metric_name +FROM awscc.iot.custom_metrics +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/dimension/index.md b/docs/awscc-docs/providers/awscc/iot/dimension/index.md new file mode 100644 index 0000000000..7ed9f2ed25 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/dimension/index.md @@ -0,0 +1,76 @@ +--- +title: dimension +hide_title: false +hide_table_of_contents: false +keywords: + - dimension + - 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 +--- +Gets an individual dimension resource + +## Overview + + + + + +
Namedimension
TypeResource
Descriptiondimension
Idawscc.iot.dimension
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringA unique identifier for the dimension.
typestringSpecifies the type of the dimension.
string_valuesarraySpecifies the value or list of values for the dimension.
tagsarrayMetadata that can be used to manage the dimension.
arnstringThe ARN (Amazon resource name) of the created dimension.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dimension resource, the following permissions are required: + +### Read +
+iot:DescribeDimension,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateDimension,
+iot:ListTagsForResource,
+iot:UntagResource,
+iot:TagResource
+ +### Delete +
+iot:DescribeDimension,
+iot:DeleteDimension
+ + +## Example +```sql +SELECT +region, +name, +type, +string_values, +tags, +arn +FROM awscc.iot.dimension +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/dimensions/index.md b/docs/awscc-docs/providers/awscc/iot/dimensions/index.md new file mode 100644 index 0000000000..70054cff90 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/dimensions/index.md @@ -0,0 +1,59 @@ +--- +title: dimensions +hide_title: false +hide_table_of_contents: false +keywords: + - dimensions + - 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 +--- +Retrieves a list of dimensions in a region + +## Overview + + + + + +
Namedimensions
TypeResource
Descriptiondimensions
Idawscc.iot.dimensions
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA unique identifier for the dimension.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dimensions resource, the following permissions are required: + +### Create +
+iot:CreateDimension,
+iot:TagResource
+ +### List +
+iot:ListDimensions
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iot.dimensions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md b/docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md new file mode 100644 index 0000000000..28217f84ef --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md @@ -0,0 +1,94 @@ +--- +title: domain_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - domain_configuration + - 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 +--- +Gets an individual domain_configuration resource + +## Overview + + + + + +
Namedomain_configuration
TypeResource
Descriptiondomain_configuration
Idawscc.iot.domain_configuration
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
domain_configuration_namestring
authorizer_configobject
domain_namestring
server_certificate_arnsarray
service_typestring
validation_certificate_arnstring
arnstring
domain_configuration_statusstring
domain_typestring
server_certificate_configobject
server_certificatesarray
tls_configobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_configuration resource, the following permissions are required: + +### Read +
+iot:DescribeDomainConfiguration,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateDomainConfiguration,
+iot:DescribeDomainConfiguration,
+iot:ListTagsForResource,
+iot:TagResource,
+iot:UntagResource
+ +### Delete +
+iot:DescribeDomainConfiguration,
+iot:DeleteDomainConfiguration,
+iot:UpdateDomainConfiguration
+ + +## Example +```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, +tags +FROM awscc.iot.domain_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainConfigurationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md b/docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md new file mode 100644 index 0000000000..5fc17ebd53 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md @@ -0,0 +1,63 @@ +--- +title: domain_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - domain_configurations + - 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 +--- +Retrieves a list of domain_configurations in a region + +## Overview + + + + + +
Namedomain_configurations
TypeResource
Descriptiondomain_configurations
Idawscc.iot.domain_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
domain_configuration_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain_configurations resource, the following permissions are required: + +### Create +
+iot:CreateDomainConfiguration,
+iot:UpdateDomainConfiguration,
+iot:DescribeDomainConfiguration,
+iot:TagResource,
+iot:ListTagsForResource,
+acm:GetCertificate
+ +### List +
+iot:ListDomainConfigurations
+ + +## Example +```sql +SELECT +region, +domain_configuration_name +FROM awscc.iot.domain_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md b/docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md new file mode 100644 index 0000000000..dd61147846 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md @@ -0,0 +1,95 @@ +--- +title: fleet_metric +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_metric + - 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 +--- +Gets an individual fleet_metric resource + +## Overview + + + + + +
Namefleet_metric
TypeResource
Descriptionfleet_metric
Idawscc.iot.fleet_metric
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
metric_namestringThe name of the fleet metric
descriptionstringThe description of a fleet metric
query_stringstringThe Fleet Indexing query used by a fleet metric
periodintegerThe period of metric emission in seconds
aggregation_fieldstringThe aggregation field to perform aggregation and metric emission
query_versionstringThe version of a Fleet Indexing query used by a fleet metric
index_namestringThe index name of a fleet metric
unitstringThe unit of data points emitted by a fleet metric
aggregation_typeobject
metric_arnstringThe Amazon Resource Number (ARN) of a fleet metric metric
creation_datestringThe creation date of a fleet metric
last_modified_datestringThe last modified date of a fleet metric
versionnumberThe version of a fleet metric
tagsarrayAn array of key-value pairs to apply to this resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleet_metric resource, the following permissions are required: + +### Read +
+iot:DescribeFleetMetric,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateFleetMetric,
+iot:DescribeFleetMetric,
+iot:ListTagsForResource,
+iot:UntagResource,
+iot:TagResource
+ +### Delete +
+iot:DeleteFleetMetric,
+iot:DescribeFleetMetric
+ + +## Example +```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, +tags +FROM awscc.iot.fleet_metric +WHERE region = 'us-east-1' +AND data__Identifier = '<MetricName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md b/docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md new file mode 100644 index 0000000000..0035e4bafe --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md @@ -0,0 +1,60 @@ +--- +title: fleet_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_metrics + - 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 +--- +Retrieves a list of fleet_metrics in a region + +## Overview + + + + + +
Namefleet_metrics
TypeResource
Descriptionfleet_metrics
Idawscc.iot.fleet_metrics
+ +## Fields + + + + + +
NameDatatypeDescription
metric_namestringThe name of the fleet metric
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleet_metrics resource, the following permissions are required: + +### Create +
+iot:CreateFleetMetric,
+iot:DescribeFleetMetric,
+iot:TagResource
+ +### List +
+iot:ListFleetMetrics
+ + +## Example +```sql +SELECT +region, +metric_name +FROM awscc.iot.fleet_metrics +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/index.md b/docs/awscc-docs/providers/awscc/iot/index.md new file mode 100644 index 0000000000..89fd438b32 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/index.md @@ -0,0 +1,89 @@ +--- +title: iot +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iot service documentation. + +:::info Service Summary + +
+
+total resources: 52
+total selectable resources: 52
+total methods: 52
+
+
+ +::: + +## Resources +
+
+account_audit_configuration
+account_audit_configurations
+authorizer
+authorizers
+billing_group
+billing_groups
+ca_certificate
+ca_certificates
+certificate
+certificate_provider
+certificate_providers
+certificates
+custom_metric
+custom_metrics
+dimension
+dimensions
+domain_configuration
+domain_configurations
+fleet_metric
+fleet_metrics
+job_template
+job_templates
+logging
+loggings
+mitigation_action
+mitigation_actions +
+
+policies
+policy
+provisioning_template
+provisioning_templates
+resource_specific_logging
+resource_specific_loggings
+role_alias
+role_aliases
+scheduled_audit
+scheduled_audits
+security_profile
+security_profiles
+software_package
+software_package_version
+software_package_versions
+software_packages
+thing
+thing_group
+thing_groups
+thing_type
+thing_types
+things
+topic_rule
+topic_rule_destination
+topic_rule_destinations
+topic_rules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iot/job_template/index.md b/docs/awscc-docs/providers/awscc/iot/job_template/index.md new file mode 100644 index 0000000000..1bc8e03a88 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/job_template/index.md @@ -0,0 +1,85 @@ +--- +title: job_template +hide_title: false +hide_table_of_contents: false +keywords: + - job_template + - 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 +--- +Gets an individual job_template resource + +## Overview + + + + + +
Namejob_template
TypeResource
Descriptionjob_template
Idawscc.iot.job_template
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
job_arnstringOptional for copying a JobTemplate from a pre-existing Job configuration.
job_template_idstring
descriptionstringA description of the Job Template.
documentstringThe job document. Required if you don't specify a value for documentSource.
document_sourcestringAn S3 link to the job document to use in the template. Required if you don't specify a value for document.
timeout_configobjectSpecifies the amount of time each device has to finish its execution of the job.
job_executions_rollout_configobjectAllows you to create a staged rollout of a job.
abort_configobjectThe criteria that determine when and how a job abort takes place.
presigned_url_configobjectConfiguration for pre-signed S3 URLs.
job_executions_retry_configobject
maintenance_windowsarray
destination_package_versionsarray
tagsarrayMetadata that can be used to manage the JobTemplate.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the job_template resource, the following permissions are required: + +### Read +
+iot:DescribeJobTemplate
+ +### Delete +
+iot:DeleteJobTemplate
+ + +## Example +```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, +tags +FROM awscc.iot.job_template +WHERE region = 'us-east-1' +AND data__Identifier = '<JobTemplateId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/job_templates/index.md b/docs/awscc-docs/providers/awscc/iot/job_templates/index.md new file mode 100644 index 0000000000..2bfd08376c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/job_templates/index.md @@ -0,0 +1,61 @@ +--- +title: job_templates +hide_title: false +hide_table_of_contents: false +keywords: + - job_templates + - 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 +--- +Retrieves a list of job_templates in a region + +## Overview + + + + + +
Namejob_templates
TypeResource
Descriptionjob_templates
Idawscc.iot.job_templates
+ +## Fields + + + + + +
NameDatatypeDescription
job_template_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the job_templates resource, the following permissions are required: + +### Create +
+iot:CreateJobTemplate,
+iam:PassRole,
+s3:GetObject,
+iot:TagResource
+ +### List +
+iot:ListJobTemplates
+ + +## Example +```sql +SELECT +region, +job_template_id +FROM awscc.iot.job_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/logging/index.md b/docs/awscc-docs/providers/awscc/iot/logging/index.md new file mode 100644 index 0000000000..75aee72d48 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/logging/index.md @@ -0,0 +1,70 @@ +--- +title: logging +hide_title: false +hide_table_of_contents: false +keywords: + - logging + - 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 +--- +Gets an individual logging resource + +## Overview + + + + + +
Namelogging
TypeResource
Descriptionlogging
Idawscc.iot.logging
+ +## Fields + + + + + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
role_arnstringThe ARN of the role that allows IoT to write to Cloudwatch logs.
default_log_levelstringThe log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the logging resource, the following permissions are required: + +### Read +
+iot:GetV2LoggingOptions
+ +### Update +
+iot:SetV2LoggingOptions,
+iot:GetV2LoggingOptions,
+iam:PassRole
+ +### Delete +
+iot:SetV2LoggingOptions,
+iot:GetV2LoggingOptions
+ + +## Example +```sql +SELECT +region, +account_id, +role_arn, +default_log_level +FROM awscc.iot.logging +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/loggings/index.md b/docs/awscc-docs/providers/awscc/iot/loggings/index.md new file mode 100644 index 0000000000..86b8e8e46c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/loggings/index.md @@ -0,0 +1,60 @@ +--- +title: loggings +hide_title: false +hide_table_of_contents: false +keywords: + - loggings + - 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 +--- +Retrieves a list of loggings in a region + +## Overview + + + + + +
Nameloggings
TypeResource
Descriptionloggings
Idawscc.iot.loggings
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the loggings resource, the following permissions are required: + +### Create +
+iot:SetV2LoggingOptions,
+iot:GetV2LoggingOptions,
+iam:PassRole
+ +### List +
+iot:GetV2LoggingOptions
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.iot.loggings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md b/docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md new file mode 100644 index 0000000000..f2687a9024 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md @@ -0,0 +1,79 @@ +--- +title: mitigation_action +hide_title: false +hide_table_of_contents: false +keywords: + - mitigation_action + - 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 +--- +Gets an individual mitigation_action resource + +## Overview + + + + + +
Namemitigation_action
TypeResource
Descriptionmitigation_action
Idawscc.iot.mitigation_action
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
action_namestringA unique identifier for the mitigation action.
role_arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
action_paramsobject
mitigation_action_arnstring
mitigation_action_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the mitigation_action resource, the following permissions are required: + +### Read +
+iot:DescribeMitigationAction,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateMitigationAction,
+iot:ListTagsForResource,
+iot:UntagResource,
+iot:TagResource,
+iam:PassRole
+ +### Delete +
+iot:DescribeMitigationAction,
+iot:DeleteMitigationAction
+ + +## Example +```sql +SELECT +region, +action_name, +role_arn, +tags, +action_params, +mitigation_action_arn, +mitigation_action_id +FROM awscc.iot.mitigation_action +WHERE region = 'us-east-1' +AND data__Identifier = '<ActionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md b/docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md new file mode 100644 index 0000000000..5385b8fffb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md @@ -0,0 +1,61 @@ +--- +title: mitigation_actions +hide_title: false +hide_table_of_contents: false +keywords: + - mitigation_actions + - 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 +--- +Retrieves a list of mitigation_actions in a region + +## Overview + + + + + +
Namemitigation_actions
TypeResource
Descriptionmitigation_actions
Idawscc.iot.mitigation_actions
+ +## Fields + + + + + +
NameDatatypeDescription
action_namestringA unique identifier for the mitigation action.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the mitigation_actions resource, the following permissions are required: + +### Create +
+iot:CreateMitigationAction,
+iot:DescribeMitigationAction,
+iot:TagResource,
+iam:PassRole
+ +### List +
+iot:ListMitigationActions
+ + +## Example +```sql +SELECT +region, +action_name +FROM awscc.iot.mitigation_actions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/policies/index.md b/docs/awscc-docs/providers/awscc/iot/policies/index.md new file mode 100644 index 0000000000..bcd0b95d22 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/policies/index.md @@ -0,0 +1,61 @@ +--- +title: policies +hide_title: false +hide_table_of_contents: false +keywords: + - policies + - 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 +--- +Retrieves a list of policies in a region + +## Overview + + + + + +
Namepolicies
TypeResource
Descriptionpolicies
Idawscc.iot.policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +
+iot:CreatePolicy,
+iot:GetPolicy,
+iot:TagResource,
+iot:ListTagsForResource
+ +### List +
+iot:ListPolicies
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iot.policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/policy/index.md b/docs/awscc-docs/providers/awscc/iot/policy/index.md new file mode 100644 index 0000000000..dcc977a1f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/policy/index.md @@ -0,0 +1,82 @@ +--- +title: policy +hide_title: false +hide_table_of_contents: false +keywords: + - policy + - 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 +--- +Gets an individual policy resource + +## Overview + + + + + +
Namepolicy
TypeResource
Descriptionpolicy
Idawscc.iot.policy
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
policy_documentobject
policy_namestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Read +
+iot:GetPolicy,
+iot:ListTagsForResource
+ +### Delete +
+iot:DeletePolicy,
+iot:GetPolicy,
+iot:ListPolicyVersions,
+iot:DeletePolicyVersion
+ +### Update +
+iot:GetPolicy,
+iot:ListPolicyVersions,
+iot:CreatePolicyVersion,
+iot:DeletePolicyVersion,
+iot:SetDefaultPolicyVersion,
+iot:TagResource,
+iot:UntagResource,
+iot:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id, +arn, +policy_document, +policy_name, +tags +FROM awscc.iot.policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md b/docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md new file mode 100644 index 0000000000..0f14986674 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md @@ -0,0 +1,90 @@ +--- +title: provisioning_template +hide_title: false +hide_table_of_contents: false +keywords: + - provisioning_template + - 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 +--- +Gets an individual provisioning_template resource + +## Overview + + + + + +
Nameprovisioning_template
TypeResource
Descriptionprovisioning_template
Idawscc.iot.provisioning_template
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
template_arnstring
template_namestring
descriptionstring
enabledboolean
provisioning_role_arnstring
template_bodystring
template_typestring
pre_provisioning_hookobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the provisioning_template resource, the following permissions are required: + +### Read +
+iot:DescribeProvisioningTemplate,
+iot:ListTagsForResource
+ +### Update +
+iam:GetRole,
+iam:PassRole,
+iot:UpdateProvisioningTemplate,
+iot:CreateProvisioningTemplateVersion,
+iot:ListProvisioningTemplateVersions,
+iot:DeleteProvisioningTemplateVersion,
+iot:DescribeProvisioningTemplate,
+iot:TagResource,
+iot:UntagResource,
+iot:ListTagsForResource
+ +### Delete +
+iot:DeleteProvisioningTemplate,
+iot:DescribeProvisioningTemplate
+ + +## Example +```sql +SELECT +region, +template_arn, +template_name, +description, +enabled, +provisioning_role_arn, +template_body, +template_type, +pre_provisioning_hook, +tags +FROM awscc.iot.provisioning_template +WHERE region = 'us-east-1' +AND data__Identifier = '<TemplateName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md b/docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md new file mode 100644 index 0000000000..1f4e2910cf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md @@ -0,0 +1,63 @@ +--- +title: provisioning_templates +hide_title: false +hide_table_of_contents: false +keywords: + - provisioning_templates + - 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 +--- +Retrieves a list of provisioning_templates in a region + +## Overview + + + + + +
Nameprovisioning_templates
TypeResource
Descriptionprovisioning_templates
Idawscc.iot.provisioning_templates
+ +## Fields + + + + + +
NameDatatypeDescription
template_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the provisioning_templates resource, the following permissions are required: + +### Create +
+iam:GetRole,
+iam:PassRole,
+iot:CreateProvisioningTemplate,
+iot:DescribeProvisioningTemplate,
+iot:TagResource,
+iot:ListTagsForResource
+ +### List +
+iot:ListProvisioningTemplates
+ + +## Example +```sql +SELECT +region, +template_name +FROM awscc.iot.provisioning_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/resource_specific_logging/index.md b/docs/awscc-docs/providers/awscc/iot/resource_specific_logging/index.md new file mode 100644 index 0000000000..242dfabd47 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/resource_specific_logging/index.md @@ -0,0 +1,71 @@ +--- +title: resource_specific_logging +hide_title: false +hide_table_of_contents: false +keywords: + - resource_specific_logging + - 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 +--- +Gets an individual resource_specific_logging resource + +## Overview + + + + + +
Nameresource_specific_logging
TypeResource
Descriptionresource_specific_logging
Idawscc.iot.resource_specific_logging
+ +## Fields + + + + + + + + +
NameDatatypeDescription
target_typestringThe target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.
target_namestringThe target name.
log_levelstringThe log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
target_idstringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_specific_logging resource, the following permissions are required: + +### Read +
+iot:ListV2LoggingLevels
+ +### Update +
+iot:ListV2LoggingLevels,
+iot:SetV2LoggingLevel
+ +### Delete +
+iot:ListV2LoggingLevels,
+iot:DeleteV2LoggingLevel
+ + +## Example +```sql +SELECT +region, +target_type, +target_name, +log_level, +target_id +FROM awscc.iot.resource_specific_logging +WHERE region = 'us-east-1' +AND data__Identifier = '<TargetId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/resource_specific_loggings/index.md b/docs/awscc-docs/providers/awscc/iot/resource_specific_loggings/index.md new file mode 100644 index 0000000000..8720837ae8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/resource_specific_loggings/index.md @@ -0,0 +1,59 @@ +--- +title: resource_specific_loggings +hide_title: false +hide_table_of_contents: false +keywords: + - resource_specific_loggings + - 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 +--- +Retrieves a list of resource_specific_loggings in a region + +## Overview + + + + + +
Nameresource_specific_loggings
TypeResource
Descriptionresource_specific_loggings
Idawscc.iot.resource_specific_loggings
+ +## Fields + + + + + +
NameDatatypeDescription
target_idstringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_specific_loggings resource, the following permissions are required: + +### Create +
+iot:ListV2LoggingLevels,
+iot:SetV2LoggingLevel
+ +### List +
+iot:ListV2LoggingLevels
+ + +## Example +```sql +SELECT +region, +target_id +FROM awscc.iot.resource_specific_loggings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/role_alias/index.md b/docs/awscc-docs/providers/awscc/iot/role_alias/index.md new file mode 100644 index 0000000000..996e29e6b3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/role_alias/index.md @@ -0,0 +1,81 @@ +--- +title: role_alias +hide_title: false +hide_table_of_contents: false +keywords: + - role_alias + - 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 +--- +Gets an individual role_alias resource + +## Overview + + + + + +
Namerole_alias
TypeResource
Descriptionrole_alias
Idawscc.iot.role_alias
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
role_aliasstring
role_alias_arnstring
role_arnstring
credential_duration_secondsinteger
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the role_alias resource, the following permissions are required: + +### Read +
+iam:GetRole,
+iam:PassRole,
+iot:DescribeRoleAlias,
+iot:ListTagsForResource
+ +### Update +
+iam:GetRole,
+iam:PassRole,
+iot:UpdateRoleAlias,
+iot:DescribeRoleAlias,
+iot:TagResource,
+iot:UntagResource,
+iot:ListTagsForResource
+ +### Delete +
+iot:DeleteRoleAlias,
+iot:DescribeRoleAlias
+ + +## Example +```sql +SELECT +region, +role_alias, +role_alias_arn, +role_arn, +credential_duration_seconds, +tags +FROM awscc.iot.role_alias +WHERE region = 'us-east-1' +AND data__Identifier = '<RoleAlias>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/role_aliases/index.md b/docs/awscc-docs/providers/awscc/iot/role_aliases/index.md new file mode 100644 index 0000000000..c016a71b41 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/role_aliases/index.md @@ -0,0 +1,63 @@ +--- +title: role_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - role_aliases + - 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 +--- +Retrieves a list of role_aliases in a region + +## Overview + + + + + +
Namerole_aliases
TypeResource
Descriptionrole_aliases
Idawscc.iot.role_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
role_aliasstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the role_aliases resource, the following permissions are required: + +### Create +
+iam:GetRole,
+iam:PassRole,
+iot:CreateRoleAlias,
+iot:DescribeRoleAlias,
+iot:TagResource,
+iot:ListTagsForResource
+ +### List +
+iot:ListRoleAliases
+ + +## Example +```sql +SELECT +region, +role_alias +FROM awscc.iot.role_aliases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md b/docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md new file mode 100644 index 0000000000..27fd380ff0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md @@ -0,0 +1,80 @@ +--- +title: scheduled_audit +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_audit + - 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 +--- +Gets an individual scheduled_audit resource + +## Overview + + + + + +
Namescheduled_audit
TypeResource
Descriptionscheduled_audit
Idawscc.iot.scheduled_audit
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
scheduled_audit_namestringThe name you want to give to the scheduled audit.
frequencystringHow often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
day_of_monthstringThe 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.
day_of_weekstringThe 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.
target_check_namesarrayWhich checks are performed during the scheduled audit. Checks must be enabled for your account.
scheduled_audit_arnstringThe ARN (Amazon resource name) of the scheduled audit.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_audit resource, the following permissions are required: + +### Read +
+iot:DescribeScheduledAudit,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdateScheduledAudit,
+iot:ListTagsForResource,
+iot:UntagResource,
+iot:TagResource
+ +### Delete +
+iot:DescribeScheduledAudit,
+iot:DeleteScheduledAudit
+ + +## Example +```sql +SELECT +region, +scheduled_audit_name, +frequency, +day_of_month, +day_of_week, +target_check_names, +scheduled_audit_arn, +tags +FROM awscc.iot.scheduled_audit +WHERE region = 'us-east-1' +AND data__Identifier = '<ScheduledAuditName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md b/docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md new file mode 100644 index 0000000000..dbc09ec83d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md @@ -0,0 +1,60 @@ +--- +title: scheduled_audits +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_audits + - 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 +--- +Retrieves a list of scheduled_audits in a region + +## Overview + + + + + +
Namescheduled_audits
TypeResource
Descriptionscheduled_audits
Idawscc.iot.scheduled_audits
+ +## Fields + + + + + +
NameDatatypeDescription
scheduled_audit_namestringThe name you want to give to the scheduled audit.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_audits resource, the following permissions are required: + +### Create +
+iot:CreateScheduledAudit,
+iot:DescribeScheduledAudit,
+iot:TagResource
+ +### List +
+iot:ListScheduledAudits
+ + +## Example +```sql +SELECT +region, +scheduled_audit_name +FROM awscc.iot.scheduled_audits +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/security_profile/index.md b/docs/awscc-docs/providers/awscc/iot/security_profile/index.md new file mode 100644 index 0000000000..7b9ecc0623 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/security_profile/index.md @@ -0,0 +1,89 @@ +--- +title: security_profile +hide_title: false +hide_table_of_contents: false +keywords: + - security_profile + - 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 +--- +Gets an individual security_profile resource + +## Overview + + + + + +
Namesecurity_profile
TypeResource
Descriptionsecurity_profile
Idawscc.iot.security_profile
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
security_profile_namestringA unique identifier for the security profile.
security_profile_descriptionstringA description of the security profile.
behaviorsarraySpecifies the behaviors that, when violated by a device (thing), cause an alert.
alert_targetsobjectSpecifies the destinations to which alerts are sent.
additional_metrics_to_retain_v2arrayA 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.
metrics_export_configobjectA structure containing the mqtt topic for metrics export.
tagsarrayMetadata that can be used to manage the security profile.
target_arnsarrayA set of target ARNs that the security profile is attached to.
security_profile_arnstringThe ARN (Amazon resource name) of the created security profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_profile resource, the following permissions are required: + +### Read +
+iot:DescribeSecurityProfile,
+iot:ListTagsForResource,
+iot:ListTargetsForSecurityProfile
+ +### Update +
+iot:UpdateSecurityProfile,
+iot:ListTargetsForSecurityProfile,
+iot:AttachSecurityProfile,
+iot:DetachSecurityProfile,
+iot:ListTagsForResource,
+iot:UntagResource,
+iot:TagResource,
+iam:PassRole
+ +### Delete +
+iot:DescribeSecurityProfile,
+iot:DeleteSecurityProfile
+ + +## Example +```sql +SELECT +region, +security_profile_name, +security_profile_description, +behaviors, +alert_targets, +additional_metrics_to_retain_v2, +metrics_export_config, +tags, +target_arns, +security_profile_arn +FROM awscc.iot.security_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<SecurityProfileName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/security_profiles/index.md b/docs/awscc-docs/providers/awscc/iot/security_profiles/index.md new file mode 100644 index 0000000000..c5925894a3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/security_profiles/index.md @@ -0,0 +1,62 @@ +--- +title: security_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - security_profiles + - 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 +--- +Retrieves a list of security_profiles in a region + +## Overview + + + + + +
Namesecurity_profiles
TypeResource
Descriptionsecurity_profiles
Idawscc.iot.security_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
security_profile_namestringA unique identifier for the security profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_profiles resource, the following permissions are required: + +### Create +
+iot:CreateSecurityProfile,
+iot:AttachSecurityProfile,
+iot:DescribeSecurityProfile,
+iot:TagResource,
+iam:PassRole
+ +### List +
+iot:ListSecurityProfiles
+ + +## Example +```sql +SELECT +region, +security_profile_name +FROM awscc.iot.security_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/software_package/index.md b/docs/awscc-docs/providers/awscc/iot/software_package/index.md new file mode 100644 index 0000000000..8fd73f049a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/software_package/index.md @@ -0,0 +1,83 @@ +--- +title: software_package +hide_title: false +hide_table_of_contents: false +keywords: + - software_package + - 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 +--- +Gets an individual software_package resource + +## Overview + + + + + +
Namesoftware_package
TypeResource
Descriptionsoftware_package
Idawscc.iot.software_package
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstring
package_arnstring
package_namestring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the software_package resource, the following permissions are required: + +### Read +
+iot:GetPackage,
+iot:ListTagsForResource
+ +### Update +
+iot:CreatePackage,
+iot:UpdatePackage,
+iot:GetPackage,
+iot:ListTagsForResource,
+iot:TagResource,
+iot:UntagResource,
+iot:GetIndexingConfiguration
+ +### Delete +
+iot:DeletePackage,
+iot:DeletePackageVersion,
+iot:GetPackage,
+iot:GetPackageVersion,
+iot:UpdatePackage,
+iot:UpdatePackageVersion,
+iot:GetIndexingConfiguration,
+iot:ListPackageVersions
+ + +## Example +```sql +SELECT +region, +description, +package_arn, +package_name, +tags +FROM awscc.iot.software_package +WHERE region = 'us-east-1' +AND data__Identifier = '<PackageName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/software_package_version/index.md b/docs/awscc-docs/providers/awscc/iot/software_package_version/index.md new file mode 100644 index 0000000000..bb7bb6628c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/software_package_version/index.md @@ -0,0 +1,87 @@ +--- +title: software_package_version +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_version + - 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 +--- +Gets an individual software_package_version resource + +## Overview + + + + + +
Namesoftware_package_version
TypeResource
Descriptionsoftware_package_version
Idawscc.iot.software_package_version
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
attributesobject
descriptionstring
error_reasonstring
package_namestring
package_version_arnstring
statusstring
tagsarrayAn array of key-value pairs to apply to this resource.
version_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the software_package_version resource, the following permissions are required: + +### Read +
+iot:GetPackageVersion,
+iot:ListTagsForResource
+ +### Update +
+iot:UpdatePackageVersion,
+iot:GetPackageVersion,
+iot:ListTagsForResource,
+iot:TagResource,
+iot:UntagResource,
+iot:GetIndexingConfiguration
+ +### Delete +
+iot:DeletePackageVersion,
+iot:UpdatePackageVersion,
+iot:GetPackageVersion,
+iot:GetIndexingConfiguration
+ + +## Example +```sql +SELECT +region, +attributes, +description, +error_reason, +package_name, +package_version_arn, +status, +tags, +version_name +FROM awscc.iot.software_package_version +WHERE region = 'us-east-1' +AND data__Identifier = '<PackageName>' +AND data__Identifier = '<VersionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/software_package_versions/index.md b/docs/awscc-docs/providers/awscc/iot/software_package_versions/index.md new file mode 100644 index 0000000000..e7547da823 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/software_package_versions/index.md @@ -0,0 +1,63 @@ +--- +title: software_package_versions +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_versions + - 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 +--- +Retrieves a list of software_package_versions in a region + +## Overview + + + + + +
Namesoftware_package_versions
TypeResource
Descriptionsoftware_package_versions
Idawscc.iot.software_package_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
package_namestring
version_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the software_package_versions resource, the following permissions are required: + +### Create +
+iot:CreatePackageVersion,
+iot:GetPackageVersion,
+iot:TagResource,
+iot:GetIndexingConfiguration
+ +### List +
+iot:ListPackageVersions
+ + +## Example +```sql +SELECT +region, +package_name, +version_name +FROM awscc.iot.software_package_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/software_packages/index.md b/docs/awscc-docs/providers/awscc/iot/software_packages/index.md new file mode 100644 index 0000000000..a3d2769145 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/software_packages/index.md @@ -0,0 +1,61 @@ +--- +title: software_packages +hide_title: false +hide_table_of_contents: false +keywords: + - software_packages + - 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 +--- +Retrieves a list of software_packages in a region + +## Overview + + + + + +
Namesoftware_packages
TypeResource
Descriptionsoftware_packages
Idawscc.iot.software_packages
+ +## Fields + + + + + +
NameDatatypeDescription
package_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the software_packages resource, the following permissions are required: + +### Create +
+iot:CreatePackage,
+iot:GetPackage,
+iot:TagResource,
+iot:GetIndexingConfiguration
+ +### List +
+iot:ListPackages
+ + +## Example +```sql +SELECT +region, +package_name +FROM awscc.iot.software_packages +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/thing/index.md b/docs/awscc-docs/providers/awscc/iot/thing/index.md new file mode 100644 index 0000000000..4c71eccdcd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/thing/index.md @@ -0,0 +1,71 @@ +--- +title: thing +hide_title: false +hide_table_of_contents: false +keywords: + - thing + - 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 +--- +Gets an individual thing resource + +## Overview + + + + + +
Namething
TypeResource
Descriptionthing
Idawscc.iot.thing
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
attribute_payloadobject
thing_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the thing resource, the following permissions are required: + +### Delete +
+iot:DeleteThing,
+iot:DescribeThing
+ +### Read +
+iot:DescribeThing
+ +### Update +
+iot:UpdateThing,
+iot:DescribeThing
+ + +## Example +```sql +SELECT +region, +id, +arn, +attribute_payload, +thing_name +FROM awscc.iot.thing +WHERE region = 'us-east-1' +AND data__Identifier = '<ThingName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/thing_group/index.md b/docs/awscc-docs/providers/awscc/iot/thing_group/index.md new file mode 100644 index 0000000000..60359f53d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/thing_group/index.md @@ -0,0 +1,83 @@ +--- +title: thing_group +hide_title: false +hide_table_of_contents: false +keywords: + - thing_group + - 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 +--- +Gets an individual thing_group resource + +## Overview + + + + + +
Namething_group
TypeResource
Descriptionthing_group
Idawscc.iot.thing_group
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
thing_group_namestring
parent_group_namestring
query_stringstring
thing_group_propertiesobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the thing_group resource, the following permissions are required: + +### Delete +
+iot:DescribeThingGroup,
+iot:DeleteThingGroup,
+iot:DeleteDynamicThingGroup
+ +### Read +
+iot:DescribeThingGroup,
+iot:ListTagsForResource
+ +### Update +
+iot:ListTagsForResource,
+iot:DescribeThingGroup,
+iot:UpdateThingGroup,
+iot:UpdateDynamicThingGroup,
+iot:TagResource,
+iot:UntagResource
+ + +## Example +```sql +SELECT +region, +id, +arn, +thing_group_name, +parent_group_name, +query_string, +thing_group_properties, +tags +FROM awscc.iot.thing_group +WHERE region = 'us-east-1' +AND data__Identifier = '<ThingGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/thing_groups/index.md b/docs/awscc-docs/providers/awscc/iot/thing_groups/index.md new file mode 100644 index 0000000000..64d26cabcc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/thing_groups/index.md @@ -0,0 +1,63 @@ +--- +title: thing_groups +hide_title: false +hide_table_of_contents: false +keywords: + - thing_groups + - 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 +--- +Retrieves a list of thing_groups in a region + +## Overview + + + + + +
Namething_groups
TypeResource
Descriptionthing_groups
Idawscc.iot.thing_groups
+ +## Fields + + + + + +
NameDatatypeDescription
thing_group_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the thing_groups resource, the following permissions are required: + +### Create +
+iot:DescribeThingGroup,
+iot:ListTagsForResource,
+iot:CreateThingGroup,
+iot:CreateDynamicThingGroup,
+iot:TagResource
+ +### List +
+iot:ListThingGroups,
+iot:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +thing_group_name +FROM awscc.iot.thing_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/thing_type/index.md b/docs/awscc-docs/providers/awscc/iot/thing_type/index.md new file mode 100644 index 0000000000..992172b456 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/thing_type/index.md @@ -0,0 +1,81 @@ +--- +title: thing_type +hide_title: false +hide_table_of_contents: false +keywords: + - thing_type + - 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 +--- +Gets an individual thing_type resource + +## Overview + + + + + +
Namething_type
TypeResource
Descriptionthing_type
Idawscc.iot.thing_type
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
thing_type_namestring
deprecate_thing_typeboolean
thing_type_propertiesobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the thing_type resource, the following permissions are required: + +### Delete +
+iot:DescribeThingType,
+iot:DeleteThingType,
+iot:DeprecateThingType
+ +### Read +
+iot:DescribeThingType,
+iot:ListTagsForResource
+ +### Update +
+iot:DescribeThingType,
+iot:UpdateThingType,
+iot:ListTagsForResource,
+iot:TagResource,
+iot:UntagResource,
+iot:DeprecateThingType
+ + +## Example +```sql +SELECT +region, +id, +arn, +thing_type_name, +deprecate_thing_type, +thing_type_properties, +tags +FROM awscc.iot.thing_type +WHERE region = 'us-east-1' +AND data__Identifier = '<ThingTypeName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/thing_types/index.md b/docs/awscc-docs/providers/awscc/iot/thing_types/index.md new file mode 100644 index 0000000000..be1bd91724 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/thing_types/index.md @@ -0,0 +1,63 @@ +--- +title: thing_types +hide_title: false +hide_table_of_contents: false +keywords: + - thing_types + - 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 +--- +Retrieves a list of thing_types in a region + +## Overview + + + + + +
Namething_types
TypeResource
Descriptionthing_types
Idawscc.iot.thing_types
+ +## Fields + + + + + +
NameDatatypeDescription
thing_type_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the thing_types resource, the following permissions are required: + +### Create +
+iot:DescribeThingType,
+iot:ListTagsForResource,
+iot:CreateThingType,
+iot:DeprecateThingType,
+iot:TagResource
+ +### List +
+iot:ListThingTypes,
+iot:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +thing_type_name +FROM awscc.iot.thing_types +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/things/index.md b/docs/awscc-docs/providers/awscc/iot/things/index.md new file mode 100644 index 0000000000..2ec23c6e70 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/things/index.md @@ -0,0 +1,59 @@ +--- +title: things +hide_title: false +hide_table_of_contents: false +keywords: + - things + - 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 +--- +Retrieves a list of things in a region + +## Overview + + + + + +
Namethings
TypeResource
Descriptionthings
Idawscc.iot.things
+ +## Fields + + + + + +
NameDatatypeDescription
thing_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the things resource, the following permissions are required: + +### Create +
+iot:CreateThing,
+iot:DescribeThing
+ +### List +
+iot:ListThings
+ + +## Example +```sql +SELECT +region, +thing_name +FROM awscc.iot.things +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/topic_rule/index.md b/docs/awscc-docs/providers/awscc/iot/topic_rule/index.md new file mode 100644 index 0000000000..014669b21b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/topic_rule/index.md @@ -0,0 +1,76 @@ +--- +title: topic_rule +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rule + - 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 +--- +Gets an individual topic_rule resource + +## Overview + + + + + +
Nametopic_rule
TypeResource
Descriptiontopic_rule
Idawscc.iot.topic_rule
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring
rule_namestring
topic_rule_payloadobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_rule resource, the following permissions are required: + +### Read +
+iot:GetTopicRule,
+iot:ListTagsForResource
+ +### Update +
+iam:PassRole,
+iot:GetTopicRule,
+iot:ListTagsForResource,
+iot:ReplaceTopicRule,
+iot:TagResource,
+iot:UntagResource
+ +### Delete +
+iot:GetTopicRule,
+iot:DeleteTopicRule
+ + +## Example +```sql +SELECT +region, +arn, +rule_name, +topic_rule_payload, +tags +FROM awscc.iot.topic_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<RuleName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/topic_rule_destination/index.md b/docs/awscc-docs/providers/awscc/iot/topic_rule_destination/index.md new file mode 100644 index 0000000000..4daaecc132 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/topic_rule_destination/index.md @@ -0,0 +1,74 @@ +--- +title: topic_rule_destination +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rule_destination + - 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 +--- +Gets an individual topic_rule_destination resource + +## Overview + + + + + +
Nametopic_rule_destination
TypeResource
Descriptiontopic_rule_destination
Idawscc.iot.topic_rule_destination
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN).
statusstringThe status of the TopicRuleDestination.
http_url_propertiesobjectHTTP URL destination properties.
status_reasonstringThe reasoning for the current status of the TopicRuleDestination.
vpc_propertiesobjectVPC destination properties.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_rule_destination resource, the following permissions are required: + +### Read +
+iot:GetTopicRuleDestination
+ +### Update +
+iam:PassRole,
+iot:GetTopicRuleDestination,
+iot:UpdateTopicRuleDestination
+ +### Delete +
+iot:GetTopicRuleDestination,
+iot:DeleteTopicRuleDestination
+ + +## Example +```sql +SELECT +region, +arn, +status, +http_url_properties, +status_reason, +vpc_properties +FROM awscc.iot.topic_rule_destination +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/topic_rule_destinations/index.md b/docs/awscc-docs/providers/awscc/iot/topic_rule_destinations/index.md new file mode 100644 index 0000000000..c99c867b9c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/topic_rule_destinations/index.md @@ -0,0 +1,61 @@ +--- +title: topic_rule_destinations +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rule_destinations + - 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 +--- +Retrieves a list of topic_rule_destinations in a region + +## Overview + + + + + +
Nametopic_rule_destinations
TypeResource
Descriptiontopic_rule_destinations
Idawscc.iot.topic_rule_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_rule_destinations resource, the following permissions are required: + +### Create +
+iam:PassRole,
+iot:CreateTopicRuleDestination,
+iot:GetTopicRuleDestination,
+iot:UpdateTopicRuleDestination
+ +### List +
+iot:ListTopicRuleDestinations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.iot.topic_rule_destinations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iot/topic_rules/index.md b/docs/awscc-docs/providers/awscc/iot/topic_rules/index.md new file mode 100644 index 0000000000..e639ebab24 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iot/topic_rules/index.md @@ -0,0 +1,62 @@ +--- +title: topic_rules +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rules + - 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 +--- +Retrieves a list of topic_rules in a region + +## Overview + + + + + +
Nametopic_rules
TypeResource
Descriptiontopic_rules
Idawscc.iot.topic_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_rules resource, the following permissions are required: + +### Create +
+iam:PassRole,
+iot:CreateTopicRule,
+iot:GetTopicRule,
+iot:TagResource,
+iot:ListTagsForResource
+ +### List +
+iot:ListTopicRules
+ + +## Example +```sql +SELECT +region, +rule_name +FROM awscc.iot.topic_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md new file mode 100644 index 0000000000..bdb76ca33a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md @@ -0,0 +1,82 @@ +--- +title: dataset +hide_title: false +hide_table_of_contents: false +keywords: + - dataset + - 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 +--- +Gets an individual dataset resource + +## Overview + + + + + +
Namedataset
TypeResource
Descriptiondataset
Idawscc.iotanalytics.dataset
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
actionsarray
late_data_rulesarray
dataset_namestring
content_delivery_rulesarray
triggersarray
versioning_configurationobject
idstring
retention_periodobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +
+iotanalytics:DescribeDataset,
+iotanalytics:ListTagsForResource
+ +### Update +
+iotanalytics:UpdateDataset,
+iotanalytics:TagResource,
+iotanalytics:UntagResource
+ +### Delete +
+iotanalytics:DeleteDataset
+ + +## Example +```sql +SELECT +region, +actions, +late_data_rules, +dataset_name, +content_delivery_rules, +triggers, +versioning_configuration, +id, +retention_period, +tags +FROM awscc.iotanalytics.dataset +WHERE region = 'us-east-1' +AND data__Identifier = '<DatasetName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md new file mode 100644 index 0000000000..9ce2b12322 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md @@ -0,0 +1,58 @@ +--- +title: datasets +hide_title: false +hide_table_of_contents: false +keywords: + - datasets + - 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 +--- +Retrieves a list of datasets in a region + +## Overview + + + + + +
Namedatasets
TypeResource
Descriptiondatasets
Idawscc.iotanalytics.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +
+iotanalytics:CreateDataset
+ +### List +
+iotanalytics:ListDatasets
+ + +## Example +```sql +SELECT +region, +dataset_name +FROM awscc.iotanalytics.datasets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/index.md new file mode 100644 index 0000000000..454725d3dc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotanalytics/index.md @@ -0,0 +1,41 @@ +--- +title: iotanalytics +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iotanalytics service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+dataset
+datasets +
+
+pipeline
+pipelines +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/pipeline/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/pipeline/index.md new file mode 100644 index 0000000000..aada134df8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotanalytics/pipeline/index.md @@ -0,0 +1,72 @@ +--- +title: pipeline +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline + - 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 +--- +Gets an individual pipeline resource + +## Overview + + + + + +
Namepipeline
TypeResource
Descriptionpipeline
Idawscc.iotanalytics.pipeline
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
pipeline_namestring
tagsarray
pipeline_activitiesarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +
+iotanalytics:DescribePipeline,
+iotanalytics:ListTagsForResource
+ +### Update +
+iotanalytics:UpdatePipeline,
+iotanalytics:TagResource,
+iotanalytics:UntagResource
+ +### Delete +
+iotanalytics:DeletePipeline
+ + +## Example +```sql +SELECT +region, +id, +pipeline_name, +tags, +pipeline_activities +FROM awscc.iotanalytics.pipeline +WHERE region = 'us-east-1' +AND data__Identifier = '<PipelineName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md new file mode 100644 index 0000000000..612dc1c71f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md @@ -0,0 +1,58 @@ +--- +title: pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines + - 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 +--- +Retrieves a list of pipelines in a region + +## Overview + + + + + +
Namepipelines
TypeResource
Descriptionpipelines
Idawscc.iotanalytics.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +
+iotanalytics:CreatePipeline
+ +### List +
+iotanalytics:ListPipelines
+ + +## Example +```sql +SELECT +region, +pipeline_name +FROM awscc.iotanalytics.pipelines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md new file mode 100644 index 0000000000..f031fe8339 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md @@ -0,0 +1,39 @@ +--- +title: iotcoredeviceadvisor +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iotcoredeviceadvisor service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+suite_definition +
+
+suite_definitions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definition/index.md b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definition/index.md new file mode 100644 index 0000000000..6f1c515a08 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definition/index.md @@ -0,0 +1,86 @@ +--- +title: suite_definition +hide_title: false +hide_table_of_contents: false +keywords: + - suite_definition + - 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 +--- +Gets an individual suite_definition resource + +## Overview + + + + + +
Namesuite_definition
TypeResource
Descriptionsuite_definition
Idawscc.iotcoredeviceadvisor.suite_definition
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
suite_definition_configurationobject
suite_definition_idstringThe unique identifier for the suite definition.
suite_definition_arnstringThe Amazon Resource name for the suite definition.
suite_definition_versionstringThe suite definition version of a test suite.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the suite_definition resource, the following permissions are required: + +### Read +
+iotdeviceadvisor:GetSuiteDefinition,
+iotdeviceadvisor:TagResource
+ +### Update +
+iot:DescribeCertificate,
+iot:DescribeThing,
+iot:GetPolicy,
+iot:ListAttachedPolicies,
+iot:ListCertificates,
+iot:ListPrincipalPolicies,
+iot:ListTagsForResource,
+iot:ListThingPrincipals,
+iot:ListThings,
+iotdeviceadvisor:UpdateSuiteDefinition,
+iotdeviceadvisor:GetSuiteDefinition,
+iotdeviceadvisor:UntagResource,
+iotdeviceadvisor:TagResource,
+iam:PassRole
+ +### Delete +
+iotdeviceadvisor:GetSuiteDefinition,
+iotdeviceadvisor:DeleteSuiteDefinition
+ + +## Example +```sql +SELECT +region, +suite_definition_configuration, +suite_definition_id, +suite_definition_arn, +suite_definition_version, +tags +FROM awscc.iotcoredeviceadvisor.suite_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<SuiteDefinitionId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md new file mode 100644 index 0000000000..1b8dc2ae48 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md @@ -0,0 +1,69 @@ +--- +title: suite_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - suite_definitions + - 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 +--- +Retrieves a list of suite_definitions in a region + +## Overview + + + + + +
Namesuite_definitions
TypeResource
Descriptionsuite_definitions
Idawscc.iotcoredeviceadvisor.suite_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
suite_definition_idstringThe unique identifier for the suite definition.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the suite_definitions resource, the following permissions are required: + +### Create +
+iot:DescribeCertificate,
+iot:DescribeThing,
+iot:GetPolicy,
+iot:ListAttachedPolicies,
+iot:ListCertificates,
+iot:ListPrincipalPolicies,
+iot:ListTagsForResource,
+iot:ListThingPrincipals,
+iot:ListThings,
+iotdeviceadvisor:CreateSuiteDefinition,
+iotdeviceadvisor:TagResource,
+iam:PassRole
+ +### List +
+iotdeviceadvisor:ListSuiteDefinitions
+ + +## Example +```sql +SELECT +region, +suite_definition_id +FROM awscc.iotcoredeviceadvisor.suite_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md b/docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md new file mode 100644 index 0000000000..051b94a7de --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md @@ -0,0 +1,87 @@ +--- +title: alarm_model +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_model + - 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 +--- +Gets an individual alarm_model resource + +## Overview + + + + + +
Namealarm_model
TypeResource
Descriptionalarm_model
Idawscc.iotevents.alarm_model
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
alarm_model_namestringThe name of the alarm model.
alarm_model_descriptionstringA brief description of the alarm model.
role_arnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
keystringThe 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.<br/><br/>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.
severityintegerA non-negative integer that reflects the severity level of the alarm.<br/><br/>
alarm_ruleobject
alarm_event_actionsobject
alarm_capabilitiesobject
tagsarrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alarm_model resource, the following permissions are required: + +### Read +
+iotevents:DescribeAlarmModel,
+iotevents:ListTagsForResource
+ +### Update +
+iotevents:UpdateAlarmModel,
+iotevents:UpdateInputRouting,
+iotevents:DescribeAlarmModel,
+iotevents:ListTagsForResource,
+iotevents:UntagResource,
+iotevents:TagResource,
+iam:PassRole
+ +### Delete +
+iotevents:DeleteAlarmModel,
+iotevents:DescribeAlarmModel
+ + +## Example +```sql +SELECT +region, +alarm_model_name, +alarm_model_description, +role_arn, +key, +severity, +alarm_rule, +alarm_event_actions, +alarm_capabilities, +tags +FROM awscc.iotevents.alarm_model +WHERE region = 'us-east-1' +AND data__Identifier = '<AlarmModelName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md b/docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md new file mode 100644 index 0000000000..8d5a2ff725 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md @@ -0,0 +1,63 @@ +--- +title: alarm_models +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_models + - 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 +--- +Retrieves a list of alarm_models in a region + +## Overview + + + + + +
Namealarm_models
TypeResource
Descriptionalarm_models
Idawscc.iotevents.alarm_models
+ +## Fields + + + + + +
NameDatatypeDescription
alarm_model_namestringThe name of the alarm model.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alarm_models resource, the following permissions are required: + +### Create +
+iotevents:CreateAlarmModel,
+iotevents:UpdateInputRouting,
+iotevents:DescribeAlarmModel,
+iotevents:ListTagsForResource,
+iotevents:TagResource,
+iam:PassRole
+ +### List +
+iotevents:ListAlarmModels
+ + +## Example +```sql +SELECT +region, +alarm_model_name +FROM awscc.iotevents.alarm_models +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md b/docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md new file mode 100644 index 0000000000..9df1690da5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md @@ -0,0 +1,83 @@ +--- +title: detector_model +hide_title: false +hide_table_of_contents: false +keywords: + - detector_model + - 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 +--- +Gets an individual detector_model resource + +## Overview + + + + + +
Namedetector_model
TypeResource
Descriptiondetector_model
Idawscc.iotevents.detector_model
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
detector_model_definitionobject
detector_model_descriptionstringA brief description of the detector model.
detector_model_namestringThe name of the detector model.
evaluation_methodstringInformation about the order in which events are evaluated and how actions are executed.
keystringThe 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.<br/><br/>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.
role_arnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
tagsarrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the detector_model resource, the following permissions are required: + +### Read +
+iotevents:DescribeDetectorModel,
+iotevents:ListTagsForResource
+ +### Update +
+iotevents:UpdateDetectorModel,
+iotevents:UpdateInputRouting,
+iotevents:DescribeDetectorModel,
+iotevents:ListTagsForResource,
+iotevents:UntagResource,
+iotevents:TagResource,
+iam:PassRole
+ +### Delete +
+iotevents:DeleteDetectorModel,
+iotevents:DescribeDetectorModel
+ + +## Example +```sql +SELECT +region, +detector_model_definition, +detector_model_description, +detector_model_name, +evaluation_method, +key, +role_arn, +tags +FROM awscc.iotevents.detector_model +WHERE region = 'us-east-1' +AND data__Identifier = '<DetectorModelName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md b/docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md new file mode 100644 index 0000000000..8f82be66c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md @@ -0,0 +1,63 @@ +--- +title: detector_models +hide_title: false +hide_table_of_contents: false +keywords: + - detector_models + - 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 +--- +Retrieves a list of detector_models in a region + +## Overview + + + + + +
Namedetector_models
TypeResource
Descriptiondetector_models
Idawscc.iotevents.detector_models
+ +## Fields + + + + + +
NameDatatypeDescription
detector_model_namestringThe name of the detector model.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the detector_models resource, the following permissions are required: + +### Create +
+iotevents:CreateDetectorModel,
+iotevents:UpdateInputRouting,
+iotevents:DescribeDetectorModel,
+iotevents:ListTagsForResource,
+iotevents:TagResource,
+iam:PassRole
+ +### List +
+iotevents:ListDetectorModels
+ + +## Example +```sql +SELECT +region, +detector_model_name +FROM awscc.iotevents.detector_models +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotevents/index.md b/docs/awscc-docs/providers/awscc/iotevents/index.md new file mode 100644 index 0000000000..afe1a5f1d0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotevents/index.md @@ -0,0 +1,43 @@ +--- +title: iotevents +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iotevents service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+alarm_model
+alarm_models
+detector_model +
+
+detector_models
+input
+inputs +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iotevents/input/index.md b/docs/awscc-docs/providers/awscc/iotevents/input/index.md new file mode 100644 index 0000000000..9c6bdba285 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotevents/input/index.md @@ -0,0 +1,75 @@ +--- +title: input +hide_title: false +hide_table_of_contents: false +keywords: + - input + - 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 +--- +Gets an individual input resource + +## Overview + + + + + +
Nameinput
TypeResource
Descriptioninput
Idawscc.iotevents.input
+ +## Fields + + + + + + + + +
NameDatatypeDescription
input_definitionobject
input_descriptionstringA brief description of the input.
input_namestringThe name of the input.
tagsarrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the input resource, the following permissions are required: + +### Read +
+iotevents:DescribeInput,
+iotevents:ListTagsForResource
+ +### Update +
+iotevents:UpdateInput,
+iotevents:DescribeInput,
+iotevents:ListTagsForResource,
+iotevents:UntagResource,
+iotevents:TagResource
+ +### Delete +
+iotevents:DeleteInput,
+iotevents:DescribeInput
+ + +## Example +```sql +SELECT +region, +input_definition, +input_description, +input_name, +tags +FROM awscc.iotevents.input +WHERE region = 'us-east-1' +AND data__Identifier = '<InputName>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotevents/inputs/index.md b/docs/awscc-docs/providers/awscc/iotevents/inputs/index.md new file mode 100644 index 0000000000..752d865c07 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotevents/inputs/index.md @@ -0,0 +1,61 @@ +--- +title: inputs +hide_title: false +hide_table_of_contents: false +keywords: + - inputs + - 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 +--- +Retrieves a list of inputs in a region + +## Overview + + + + + +
Nameinputs
TypeResource
Descriptioninputs
Idawscc.iotevents.inputs
+ +## Fields + + + + + +
NameDatatypeDescription
input_namestringThe name of the input.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the inputs resource, the following permissions are required: + +### Create +
+iotevents:CreateInput,
+iotevents:TagResource,
+iotevents:DescribeInput,
+iotevents:ListTagsForResource
+ +### List +
+iotevents:ListInputs
+ + +## Example +```sql +SELECT +region, +input_name +FROM awscc.iotevents.inputs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleethub/application/index.md b/docs/awscc-docs/providers/awscc/iotfleethub/application/index.md new file mode 100644 index 0000000000..9abf5af89d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleethub/application/index.md @@ -0,0 +1,90 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.iotfleethub.application
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
application_idstringThe ID of the application.
application_arnstringThe ARN of the application.
application_namestringApplication Name, should be between 1 and 256 characters.
application_descriptionstringApplication Description, should be between 1 and 2048 characters.
application_urlstringThe URL of the application.
application_statestringThe current state of the application.
application_creation_dateintegerWhen the Application was created
application_last_update_dateintegerWhen the Application was last updated
role_arnstringThe 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
sso_client_idstringThe AWS SSO application generated client ID (used with AWS SSO APIs).
error_messagestringA message indicating why Create or Delete Application failed.
tagsarrayA list of key-value pairs that contain metadata for the application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+iotfleethub:DescribeApplication
+ +### Update +
+iotfleethub:UpdateApplication,
+iotfleethub:DescribeApplication,
+iotfleethub:TagResource,
+iotfleethub:UntagResource
+ +### Delete +
+iotfleethub:DeleteApplication,
+iotfleethub:DescribeApplication,
+sso:DeleteManagedApplicationInstance
+ + +## Example +```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, +tags +FROM awscc.iotfleethub.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md b/docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md new file mode 100644 index 0000000000..fa9d83851e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md @@ -0,0 +1,62 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.iotfleethub.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_idstringThe ID of the application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+iotfleethub:CreateApplication,
+iotfleethub:TagResource,
+iam:PassRole,
+sso:CreateManagedApplicationInstance,
+sso:DescribeRegisteredRegions
+ +### List +
+iotfleethub:ListApplications
+ + +## Example +```sql +SELECT +region, +application_id +FROM awscc.iotfleethub.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleethub/index.md b/docs/awscc-docs/providers/awscc/iotfleethub/index.md new file mode 100644 index 0000000000..cdf604aee7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleethub/index.md @@ -0,0 +1,39 @@ +--- +title: iotfleethub +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iotfleethub service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+application +
+
+applications +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/campaign/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/campaign/index.md new file mode 100644 index 0000000000..1547a40b6c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/campaign/index.md @@ -0,0 +1,109 @@ +--- +title: campaign +hide_title: false +hide_table_of_contents: false +keywords: + - campaign + - 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 +--- +Gets an individual campaign resource + +## Overview + + + + + +
Namecampaign
TypeResource
Descriptioncampaign
Idawscc.iotfleetwise.campaign
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
statusstring
actionstring
creation_timestring
compressionstring
descriptionstring
priorityinteger
signals_to_collectarray
data_destination_configsarray
start_timestring
namestring
expiry_timestring
last_modification_timestring
spooling_modestring
signal_catalog_arnstring
post_trigger_collection_durationnumber
data_extra_dimensionsarray
diagnostics_modestring
target_arnstring
arnstring
collection_schemeundefined
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the campaign resource, the following permissions are required: + +### Read +
+iotfleetwise:GetCampaign,
+iotfleetwise:ListTagsForResource
+ +### Update +
+iotfleetwise:GetCampaign,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:UpdateCampaign,
+iotfleetwise:TagResource,
+iotfleetwise:UntagResource
+ +### Delete +
+iotfleetwise:DeleteCampaign,
+iotfleetwise:GetCampaign
+ + +## Example +```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, +tags +FROM awscc.iotfleetwise.campaign +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md new file mode 100644 index 0000000000..55dab4e685 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md @@ -0,0 +1,65 @@ +--- +title: campaigns +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns + - 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 +--- +Retrieves a list of campaigns in a region + +## Overview + + + + + +
Namecampaigns
TypeResource
Descriptioncampaigns
Idawscc.iotfleetwise.campaigns
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the campaigns resource, the following permissions are required: + +### Create +
+iotfleetwise:CreateCampaign,
+iotfleetwise:GetCampaign,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource,
+iam:PassRole,
+timestream:DescribeEndpoints,
+timestream:DescribeTable
+ +### List +
+iotfleetwise:ListCampaigns,
+iotfleetwise:GetCampaign
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iotfleetwise.campaigns +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md new file mode 100644 index 0000000000..82e5130885 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md @@ -0,0 +1,91 @@ +--- +title: decoder_manifest +hide_title: false +hide_table_of_contents: false +keywords: + - decoder_manifest + - 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 +--- +Gets an individual decoder_manifest resource + +## Overview + + + + + +
Namedecoder_manifest
TypeResource
Descriptiondecoder_manifest
Idawscc.iotfleetwise.decoder_manifest
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
model_manifest_arnstring
namestring
network_interfacesarray
signal_decodersarray
statusstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the decoder_manifest resource, the following permissions are required: + +### Read +
+iotfleetwise:GetDecoderManifest,
+iotfleetwise:ListDecoderManifestSignals,
+iotfleetwise:ListDecoderManifestNetworkInterfaces,
+iotfleetwise:ListTagsForResource
+ +### Update +
+iotfleetwise:UpdateDecoderManifest,
+iotfleetwise:GetDecoderManifest,
+iotfleetwise:ListDecoderManifestSignals,
+iotfleetwise:ListDecoderManifestNetworkInterfaces,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource,
+iotfleetwise:UntagResource
+ +### Delete +
+iotfleetwise:DeleteDecoderManifest,
+iotfleetwise:GetDecoderManifest
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +model_manifest_arn, +name, +network_interfaces, +signal_decoders, +status, +tags +FROM awscc.iotfleetwise.decoder_manifest +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md new file mode 100644 index 0000000000..62416fdfe8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md @@ -0,0 +1,64 @@ +--- +title: decoder_manifests +hide_title: false +hide_table_of_contents: false +keywords: + - decoder_manifests + - 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 +--- +Retrieves a list of decoder_manifests in a region + +## Overview + + + + + +
Namedecoder_manifests
TypeResource
Descriptiondecoder_manifests
Idawscc.iotfleetwise.decoder_manifests
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the decoder_manifests resource, the following permissions are required: + +### Create +
+iotfleetwise:CreateDecoderManifest,
+iotfleetwise:GetDecoderManifest,
+iotfleetwise:UpdateDecoderManifest,
+iotfleetwise:ListDecoderManifestSignals,
+iotfleetwise:ListDecoderManifestNetworkInterfaces,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource
+ +### List +
+iotfleetwise:ListDecoderManifests
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iotfleetwise.decoder_manifests +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md new file mode 100644 index 0000000000..02121dd537 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md @@ -0,0 +1,81 @@ +--- +title: fleet +hide_title: false +hide_table_of_contents: false +keywords: + - fleet + - 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 +--- +Gets an individual fleet resource + +## Overview + + + + + +
Namefleet
TypeResource
Descriptionfleet
Idawscc.iotfleetwise.fleet
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
idstring
last_modification_timestring
signal_catalog_arnstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Read +
+iotfleetwise:GetFleet,
+iotfleetwise:ListTagsForResource
+ +### Update +
+iotfleetwise:GetFleet,
+iotfleetwise:UpdateFleet,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource,
+iotfleetwise:UntagResource
+ +### Delete +
+iotfleetwise:GetFleet,
+iotfleetwise:DeleteFleet
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +description, +id, +last_modification_time, +signal_catalog_arn, +tags +FROM awscc.iotfleetwise.fleet +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md new file mode 100644 index 0000000000..84ed2a6e81 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md @@ -0,0 +1,62 @@ +--- +title: fleets +hide_title: false +hide_table_of_contents: false +keywords: + - fleets + - 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 +--- +Retrieves a list of fleets in a region + +## Overview + + + + + +
Namefleets
TypeResource
Descriptionfleets
Idawscc.iotfleetwise.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +
+iotfleetwise:GetFleet,
+iotfleetwise:CreateFleet,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:ListVehiclesInFleet,
+iotfleetwise:TagResource
+ +### List +
+iotfleetwise:ListFleets
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotfleetwise.fleets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/index.md new file mode 100644 index 0000000000..a7da867f00 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/index.md @@ -0,0 +1,49 @@ +--- +title: iotfleetwise +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iotfleetwise service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+campaign
+campaigns
+decoder_manifest
+decoder_manifests
+fleet
+fleets +
+
+model_manifest
+model_manifests
+signal_catalog
+signal_catalogs
+vehicle
+vehicles +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifest/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifest/index.md new file mode 100644 index 0000000000..ba85fa824d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifest/index.md @@ -0,0 +1,87 @@ +--- +title: model_manifest +hide_title: false +hide_table_of_contents: false +keywords: + - model_manifest + - 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 +--- +Gets an individual model_manifest resource + +## Overview + + + + + +
Namemodel_manifest
TypeResource
Descriptionmodel_manifest
Idawscc.iotfleetwise.model_manifest
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
namestring
nodesarray
signal_catalog_arnstring
statusstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_manifest resource, the following permissions are required: + +### Read +
+iotfleetwise:GetModelManifest,
+iotfleetwise:ListModelManifestNodes,
+iotfleetwise:ListTagsForResource
+ +### Update +
+iotfleetwise:UpdateModelManifest,
+iotfleetwise:GetModelManifest,
+iotfleetwise:ListModelManifestNodes,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource,
+iotfleetwise:UntagResource
+ +### Delete +
+iotfleetwise:DeleteModelManifest,
+iotfleetwise:GetModelManifest
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +nodes, +signal_catalog_arn, +status, +tags +FROM awscc.iotfleetwise.model_manifest +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md new file mode 100644 index 0000000000..25555a0d53 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md @@ -0,0 +1,63 @@ +--- +title: model_manifests +hide_title: false +hide_table_of_contents: false +keywords: + - model_manifests + - 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 +--- +Retrieves a list of model_manifests in a region + +## Overview + + + + + +
Namemodel_manifests
TypeResource
Descriptionmodel_manifests
Idawscc.iotfleetwise.model_manifests
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_manifests resource, the following permissions are required: + +### Create +
+iotfleetwise:CreateModelManifest,
+iotfleetwise:GetModelManifest,
+iotfleetwise:UpdateModelManifest,
+iotfleetwise:ListModelManifestNodes,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource
+ +### List +
+iotfleetwise:ListModelManifests
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iotfleetwise.model_manifests +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md new file mode 100644 index 0000000000..585ba47b75 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md @@ -0,0 +1,85 @@ +--- +title: signal_catalog +hide_title: false +hide_table_of_contents: false +keywords: + - signal_catalog + - 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 +--- +Gets an individual signal_catalog resource + +## Overview + + + + + +
Namesignal_catalog
TypeResource
Descriptionsignal_catalog
Idawscc.iotfleetwise.signal_catalog
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
namestring
node_countsobject
nodesarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the signal_catalog resource, the following permissions are required: + +### Read +
+iotfleetwise:GetSignalCatalog,
+iotfleetwise:ListSignalCatalogNodes,
+iotfleetwise:ListTagsForResource
+ +### Update +
+iotfleetwise:GetSignalCatalog,
+iotfleetwise:UpdateSignalCatalog,
+iotfleetwise:ListSignalCatalogNodes,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource,
+iotfleetwise:UntagResource
+ +### Delete +
+iotfleetwise:GetSignalCatalog,
+iotfleetwise:DeleteSignalCatalog
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +node_counts, +nodes, +tags +FROM awscc.iotfleetwise.signal_catalog +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md new file mode 100644 index 0000000000..191770fcab --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md @@ -0,0 +1,62 @@ +--- +title: signal_catalogs +hide_title: false +hide_table_of_contents: false +keywords: + - signal_catalogs + - 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 +--- +Retrieves a list of signal_catalogs in a region + +## Overview + + + + + +
Namesignal_catalogs
TypeResource
Descriptionsignal_catalogs
Idawscc.iotfleetwise.signal_catalogs
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the signal_catalogs resource, the following permissions are required: + +### Create +
+iotfleetwise:GetSignalCatalog,
+iotfleetwise:CreateSignalCatalog,
+iotfleetwise:ListSignalCatalogNodes,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource
+ +### List +
+iotfleetwise:ListSignalCatalogs
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iotfleetwise.signal_catalogs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md new file mode 100644 index 0000000000..5929a11925 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md @@ -0,0 +1,85 @@ +--- +title: vehicle +hide_title: false +hide_table_of_contents: false +keywords: + - vehicle + - 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 +--- +Gets an individual vehicle resource + +## Overview + + + + + +
Namevehicle
TypeResource
Descriptionvehicle
Idawscc.iotfleetwise.vehicle
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
association_behaviorstring
attributesobject
creation_timestring
decoder_manifest_arnstring
namestring
last_modification_timestring
model_manifest_arnstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vehicle resource, the following permissions are required: + +### Read +
+iotfleetwise:GetVehicle,
+iotfleetwise:ListTagsForResource
+ +### Update +
+iotfleetwise:GetVehicle,
+iotfleetwise:UpdateVehicle,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:TagResource,
+iotfleetwise:UntagResource
+ +### Delete +
+iotfleetwise:GetVehicle,
+iotfleetwise:DeleteVehicle
+ + +## Example +```sql +SELECT +region, +arn, +association_behavior, +attributes, +creation_time, +decoder_manifest_arn, +name, +last_modification_time, +model_manifest_arn, +tags +FROM awscc.iotfleetwise.vehicle +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md new file mode 100644 index 0000000000..67400cdc0c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md @@ -0,0 +1,64 @@ +--- +title: vehicles +hide_title: false +hide_table_of_contents: false +keywords: + - vehicles + - 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 +--- +Retrieves a list of vehicles in a region + +## Overview + + + + + +
Namevehicles
TypeResource
Descriptionvehicles
Idawscc.iotfleetwise.vehicles
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vehicles resource, the following permissions are required: + +### Create +
+iotfleetwise:GetVehicle,
+iotfleetwise:CreateVehicle,
+iot:CreateThing,
+iot:DescribeThing,
+iotfleetwise:ListTagsForResource,
+iotfleetwise:ListVehicles,
+iotfleetwise:TagResource
+ +### List +
+iotfleetwise:ListVehicles
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iotfleetwise.vehicles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md new file mode 100644 index 0000000000..bfc0d3579a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md @@ -0,0 +1,58 @@ +--- +title: access_policies +hide_title: false +hide_table_of_contents: false +keywords: + - access_policies + - 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 +--- +Retrieves a list of access_policies in a region + +## Overview + + + + + +
Nameaccess_policies
TypeResource
Descriptionaccess_policies
Idawscc.iotsitewise.access_policies
+ +## Fields + + + + + +
NameDatatypeDescription
access_policy_idstringThe ID of the access policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_policies resource, the following permissions are required: + +### Create +
+iotsitewise:CreateAccessPolicy
+ +### List +
+iotsitewise:ListAccessPolicies
+ + +## Example +```sql +SELECT +region, +access_policy_id +FROM awscc.iotsitewise.access_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md new file mode 100644 index 0000000000..7bbb4d3af2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md @@ -0,0 +1,73 @@ +--- +title: access_policy +hide_title: false +hide_table_of_contents: false +keywords: + - access_policy + - 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 +--- +Gets an individual access_policy resource + +## Overview + + + + + +
Nameaccess_policy
TypeResource
Descriptionaccess_policy
Idawscc.iotsitewise.access_policy
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
access_policy_idstringThe ID of the access policy.
access_policy_arnstringThe ARN of the access policy.
access_policy_identityobjectThe identity for this access policy. Choose either a user or a group but not both.
access_policy_permissionstringThe permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
access_policy_resourceobjectThe AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_policy resource, the following permissions are required: + +### Read +
+iotsitewise:DescribeAccessPolicy
+ +### Update +
+iotsitewise:DescribeAccessPolicy,
+iotsitewise:UpdateAccessPolicy
+ +### Delete +
+iotsitewise:DescribeAccessPolicy,
+iotsitewise:DeleteAccessPolicy
+ + +## Example +```sql +SELECT +region, +access_policy_id, +access_policy_arn, +access_policy_identity, +access_policy_permission, +access_policy_resource +FROM awscc.iotsitewise.access_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<AccessPolicyId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md new file mode 100644 index 0000000000..e0e8b4b5bf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md @@ -0,0 +1,94 @@ +--- +title: asset +hide_title: false +hide_table_of_contents: false +keywords: + - asset + - 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 +--- +Gets an individual asset resource + +## Overview + + + + + +
Nameasset
TypeResource
Descriptionasset
Idawscc.iotsitewise.asset
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
asset_idstringThe ID of the asset
asset_model_idstringThe ID of the asset model from which to create the asset.
asset_arnstringThe ARN of the asset
asset_namestringA unique, friendly name for the asset.
asset_descriptionstringA description for the asset
asset_propertiesarray
asset_hierarchiesarray
tagsarrayA list of key-value pairs that contain metadata for the asset.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the asset resource, the following permissions are required: + +### Read +
+iotsitewise:DescribeAsset,
+iotsitewise:DescribeAssetModel,
+iotsitewise:ListAssociatedAssets,
+iotsitewise:ListTagsForResource
+ +### Update +
+iotsitewise:AssociateAssets,
+iotsitewise:DescribeAsset,
+iotsitewise:DescribeAssetModel,
+iotsitewise:DisassociateAssets,
+iotsitewise:ListAssociatedAssets,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iotsitewise:UpdateAsset,
+iotsitewise:UpdateAssetProperty,
+iotsitewise:UntagResource
+ +### Delete +
+iotsitewise:DeleteAsset,
+iotsitewise:DescribeAsset,
+iotsitewise:DescribeAssetModel,
+iotsitewise:DisassociateAssets,
+iotsitewise:ListAssociatedAssets,
+iotsitewise:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +asset_id, +asset_model_id, +asset_arn, +asset_name, +asset_description, +asset_properties, +asset_hierarchies, +tags +FROM awscc.iotsitewise.asset +WHERE region = 'us-east-1' +AND data__Identifier = '<AssetId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md new file mode 100644 index 0000000000..de43eb5675 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md @@ -0,0 +1,83 @@ +--- +title: asset_model +hide_title: false +hide_table_of_contents: false +keywords: + - asset_model + - 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 +--- +Gets an individual asset_model resource + +## Overview + + + + + +
Nameasset_model
TypeResource
Descriptionasset_model
Idawscc.iotsitewise.asset_model
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
asset_model_idstringThe ID of the asset model.
asset_model_arnstringThe ARN of the asset model, which has the following format.
asset_model_namestringA unique, friendly name for the asset model.
asset_model_descriptionstringA description for the asset model.
asset_model_propertiesarrayThe property definitions of the asset model. You can specify up to 200 properties per asset model.
asset_model_composite_modelsarrayThe composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
asset_model_hierarchiesarrayThe 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.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the asset_model resource, the following permissions are required: + +### Read +
+iotsitewise:DescribeAssetModel,
+iotsitewise:ListTagsForResource
+ +### Update +
+iotsitewise:DescribeAssetModel,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iotsitewise:UntagResource,
+iotsitewise:UpdateAssetModel
+ +### Delete +
+iotsitewise:DescribeAssetModel,
+iotsitewise:DeleteAssetModel
+ + +## Example +```sql +SELECT +region, +asset_model_id, +asset_model_arn, +asset_model_name, +asset_model_description, +asset_model_properties, +asset_model_composite_models, +asset_model_hierarchies, +tags +FROM awscc.iotsitewise.asset_model +WHERE region = 'us-east-1' +AND data__Identifier = '<AssetModelId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md new file mode 100644 index 0000000000..1c46a26f65 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md @@ -0,0 +1,63 @@ +--- +title: asset_models +hide_title: false +hide_table_of_contents: false +keywords: + - asset_models + - 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 +--- +Retrieves a list of asset_models in a region + +## Overview + + + + + +
Nameasset_models
TypeResource
Descriptionasset_models
Idawscc.iotsitewise.asset_models
+ +## Fields + + + + + +
NameDatatypeDescription
asset_model_idstringThe ID of the asset model.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the asset_models resource, the following permissions are required: + +### Create +
+iotsitewise:CreateAssetModel,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iotsitewise:DescribeAssetModel
+ +### List +
+iotsitewise:DescribeAssetModel,
+iotsitewise:ListAssetModels,
+iotsitewise:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +asset_model_id +FROM awscc.iotsitewise.asset_models +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md new file mode 100644 index 0000000000..422e5cd2e4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md @@ -0,0 +1,66 @@ +--- +title: assets +hide_title: false +hide_table_of_contents: false +keywords: + - assets + - 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 +--- +Retrieves a list of assets in a region + +## Overview + + + + + +
Nameassets
TypeResource
Descriptionassets
Idawscc.iotsitewise.assets
+ +## Fields + + + + + +
NameDatatypeDescription
asset_idstringThe ID of the asset
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assets resource, the following permissions are required: + +### Create +
+iotsitewise:AssociateAssets,
+iotsitewise:CreateAsset,
+iotsitewise:DescribeAsset,
+iotsitewise:DescribeAssetModel,
+iotsitewise:ListAssociatedAssets,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iotsitewise:UpdateAssetProperty
+ +### List +
+iotsitewise:ListAssetModels,
+iotsitewise:ListAssets
+ + +## Example +```sql +SELECT +region, +asset_id +FROM awscc.iotsitewise.assets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md new file mode 100644 index 0000000000..3868b6d6d5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md @@ -0,0 +1,83 @@ +--- +title: dashboard +hide_title: false +hide_table_of_contents: false +keywords: + - dashboard + - 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 +--- +Gets an individual dashboard resource + +## Overview + + + + + +
Namedashboard
TypeResource
Descriptiondashboard
Idawscc.iotsitewise.dashboard
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
project_idstringThe ID of the project in which to create the dashboard.
dashboard_idstringThe ID of the dashboard.
dashboard_namestringA friendly name for the dashboard.
dashboard_descriptionstringA description for the dashboard.
dashboard_definitionstringThe dashboard definition specified in a JSON literal.
dashboard_arnstringThe ARN of the dashboard.
tagsarrayA list of key-value pairs that contain metadata for the dashboard.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dashboard resource, the following permissions are required: + +### Read +
+iotsitewise:DescribeDashboard,
+iotsitewise:ListTagsForResource
+ +### Update +
+iotsitewise:DescribeDashboard,
+iotsitewise:UpdateDashboard,
+iotsitewise:TagResource,
+iotsitewise:UntagResource,
+iotsitewise:ListTagsForResource,
+iotsitewise:DescribeAsset,
+iotsitewise:DescribeAssetModel
+ +### Delete +
+iotsitewise:DescribeDashboard,
+iotsitewise:DeleteDashboard
+ + +## Example +```sql +SELECT +region, +project_id, +dashboard_id, +dashboard_name, +dashboard_description, +dashboard_definition, +dashboard_arn, +tags +FROM awscc.iotsitewise.dashboard +WHERE region = 'us-east-1' +AND data__Identifier = '<DashboardId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md new file mode 100644 index 0000000000..79c4807584 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md @@ -0,0 +1,63 @@ +--- +title: dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards + - 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 +--- +Retrieves a list of dashboards in a region + +## Overview + + + + + +
Namedashboards
TypeResource
Descriptiondashboards
Idawscc.iotsitewise.dashboards
+ +## Fields + + + + + +
NameDatatypeDescription
dashboard_idstringThe ID of the dashboard.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dashboards resource, the following permissions are required: + +### Create +
+iotsitewise:CreateDashboard,
+iotsitewise:DescribeDashboard,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iotsitewise:DescribeAsset,
+iotsitewise:DescribeAssetModel
+ +### List +
+iotsitewise:ListDashboards
+ + +## Example +```sql +SELECT +region, +dashboard_id +FROM awscc.iotsitewise.dashboards +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md new file mode 100644 index 0000000000..a93c359f3f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md @@ -0,0 +1,81 @@ +--- +title: gateway +hide_title: false +hide_table_of_contents: false +keywords: + - gateway + - 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 +--- +Gets an individual gateway resource + +## Overview + + + + + +
Namegateway
TypeResource
Descriptiongateway
Idawscc.iotsitewise.gateway
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
gateway_namestringA unique, friendly name for the gateway.
gateway_platformobjectThe gateway's platform. You can only specify one platform in a gateway.
tagsarrayA list of key-value pairs that contain metadata for the gateway.
gateway_idstringThe ID of the gateway device.
gateway_capability_summariesarrayA list of gateway capability summaries that each contain a namespace and status.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the gateway resource, the following permissions are required: + +### Read +
+iotsitewise:DescribeGateway,
+iotsitewise:DescribeGatewayCapabilityConfiguration,
+iotsitewise:ListTagsForResource
+ +### Update +
+iotsitewise:UpdateGateway,
+iotsitewise:UpdateGatewayCapabilityConfiguration,
+iotsitewise:TagResource,
+iotsitewise:UntagResource,
+iotsitewise:DescribeGateway,
+iotsitewise:DescribeGatewayCapabilityConfiguration,
+iotsitewise:ListTagsForResource
+ +### Delete +
+iotsitewise:DescribeGateway,
+iotsitewise:DescribeGatewayCapabilityConfiguration,
+iotsitewise:DeleteGateway
+ + +## Example +```sql +SELECT +region, +gateway_name, +gateway_platform, +tags, +gateway_id, +gateway_capability_summaries +FROM awscc.iotsitewise.gateway +WHERE region = 'us-east-1' +AND data__Identifier = '<GatewayId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md new file mode 100644 index 0000000000..c3cb30ceef --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md @@ -0,0 +1,67 @@ +--- +title: gateways +hide_title: false +hide_table_of_contents: false +keywords: + - gateways + - 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 +--- +Retrieves a list of gateways in a region + +## Overview + + + + + +
Namegateways
TypeResource
Descriptiongateways
Idawscc.iotsitewise.gateways
+ +## Fields + + + + + +
NameDatatypeDescription
gateway_idstringThe ID of the gateway device.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the gateways resource, the following permissions are required: + +### Create +
+iotsitewise:CreateGateway,
+iotsitewise:DescribeGateway,
+iotsitewise:DescribeGatewayCapabilityConfiguration,
+iotsitewise:UpdateGatewayCapabilityConfiguration,
+iam:PassRole,
+iam:GetRole,
+greengrass:GetCoreDevice,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iot:DescribeThing
+ +### List +
+iotsitewise:ListGateways
+ + +## Example +```sql +SELECT +region, +gateway_id +FROM awscc.iotsitewise.gateways +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/index.md new file mode 100644 index 0000000000..3220ace893 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/index.md @@ -0,0 +1,51 @@ +--- +title: iotsitewise +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iotsitewise service documentation. + +:::info Service Summary + +
+
+total resources: 14
+total selectable resources: 14
+total methods: 14
+
+
+ +::: + +## Resources +
+
+access_policies
+access_policy
+asset
+asset_model
+asset_models
+assets
+dashboard +
+
+dashboards
+gateway
+gateways
+portal
+portals
+project
+projects +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/portal/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/portal/index.md new file mode 100644 index 0000000000..8727302ed8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/portal/index.md @@ -0,0 +1,95 @@ +--- +title: portal +hide_title: false +hide_table_of_contents: false +keywords: + - portal + - 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 +--- +Gets an individual portal resource + +## Overview + + + + + +
Nameportal
TypeResource
Descriptionportal
Idawscc.iotsitewise.portal
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
portal_auth_modestringThe 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.
portal_arnstringThe ARN of the portal, which has the following format.
portal_client_idstringThe AWS SSO application generated client ID (used with AWS SSO APIs).
portal_contact_emailstringThe AWS administrator's contact email address.
portal_descriptionstringA description for the portal.
portal_idstringThe ID of the portal.
portal_namestringA friendly name for the portal.
portal_start_urlstringThe public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
role_arnstringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
notification_sender_emailstringThe email address that sends alarm notifications.
alarmsobjectContains 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.
tagsarrayA list of key-value pairs that contain metadata for the portal.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the portal resource, the following permissions are required: + +### Read +
+iotsitewise:DescribePortal,
+iotsitewise:ListTagsForResource
+ +### Update +
+iotsitewise:DescribePortal,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iotsitewise:UpdatePortal,
+iotsitewise:UntagResource,
+iam:PassRole,
+sso:GetManagedApplicationInstance,
+sso:UpdateApplicationInstanceDisplayData
+ +### Delete +
+iotsitewise:DescribePortal,
+iotsitewise:DeletePortal,
+sso:DeleteManagedApplicationInstance
+ + +## Example +```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, +tags +FROM awscc.iotsitewise.portal +WHERE region = 'us-east-1' +AND data__Identifier = '<PortalId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md new file mode 100644 index 0000000000..4ed5ac1d6c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md @@ -0,0 +1,64 @@ +--- +title: portals +hide_title: false +hide_table_of_contents: false +keywords: + - portals + - 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 +--- +Retrieves a list of portals in a region + +## Overview + + + + + +
Nameportals
TypeResource
Descriptionportals
Idawscc.iotsitewise.portals
+ +## Fields + + + + + +
NameDatatypeDescription
portal_idstringThe ID of the portal.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the portals resource, the following permissions are required: + +### Create +
+iotsitewise:CreatePortal,
+iotsitewise:DescribePortal,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iam:PassRole,
+sso:CreateManagedApplicationInstance,
+sso:DescribeRegisteredRegions
+ +### List +
+iotsitewise:ListPortals
+ + +## Example +```sql +SELECT +region, +portal_id +FROM awscc.iotsitewise.portals +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/project/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/project/index.md new file mode 100644 index 0000000000..66248541f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/project/index.md @@ -0,0 +1,85 @@ +--- +title: project +hide_title: false +hide_table_of_contents: false +keywords: + - project + - 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 +--- +Gets an individual project resource + +## Overview + + + + + +
Nameproject
TypeResource
Descriptionproject
Idawscc.iotsitewise.project
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
portal_idstringThe ID of the portal in which to create the project.
project_idstringThe ID of the project.
project_namestringA friendly name for the project.
project_descriptionstringA description for the project.
project_arnstringThe ARN of the project.
asset_idsarrayThe IDs of the assets to be associated to the project.
tagsarrayA list of key-value pairs that contain metadata for the project.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +
+iotsitewise:DescribeProject,
+iotsitewise:ListTagsForResource,
+iotsitewise:ListProjectAssets
+ +### Update +
+iotsitewise:DescribeProject,
+iotsitewise:UpdateProject,
+iotsitewise:BatchAssociateProjectAssets,
+iotsitewise:BatchDisAssociateProjectAssets,
+iotsitewise:ListProjectAssets,
+iotsitewise:TagResource,
+iotsitewise:UntagResource,
+iotsitewise:ListTagsForResource
+ +### Delete +
+iotsitewise:DescribeProject,
+iotsitewise:DeleteProject
+ + +## Example +```sql +SELECT +region, +portal_id, +project_id, +project_name, +project_description, +project_arn, +asset_ids, +tags +FROM awscc.iotsitewise.project +WHERE region = 'us-east-1' +AND data__Identifier = '<ProjectId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md new file mode 100644 index 0000000000..6fdb98dcc7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md @@ -0,0 +1,63 @@ +--- +title: projects +hide_title: false +hide_table_of_contents: false +keywords: + - projects + - 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 +--- +Retrieves a list of projects in a region + +## Overview + + + + + +
Nameprojects
TypeResource
Descriptionprojects
Idawscc.iotsitewise.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_idstringThe ID of the project.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +
+iotsitewise:CreateProject,
+iotsitewise:DescribeProject,
+iotsitewise:ListProjectAssets,
+iotsitewise:ListTagsForResource,
+iotsitewise:TagResource,
+iotsitewise:BatchAssociateProjectAssets
+ +### List +
+iotsitewise:ListProjects
+ + +## Example +```sql +SELECT +region, +project_id +FROM awscc.iotsitewise.projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md new file mode 100644 index 0000000000..d8041719c0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md @@ -0,0 +1,103 @@ +--- +title: component_type +hide_title: false +hide_table_of_contents: false +keywords: + - component_type + - 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 +--- +Gets an individual component_type resource + +## Overview + + + + + +
Namecomponent_type
TypeResource
Descriptioncomponent_type
Idawscc.iottwinmaker.component_type
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace that contains the component type.
component_type_idstringThe ID of the component type.
descriptionstringThe description of the component type.
extends_fromarraySpecifies the parent component type to extend.
functionsobjecta Map of functions in the component type. Each function's key must be unique to this map.
is_singletonbooleanA Boolean value that specifies whether an entity can have more than one component of this type.
property_definitionsobjectAn map of the property definitions in the component type. Each property definition's key must be unique to this map.
property_groupsobjectAn map of the property groups in the component type. Each property group's key must be unique to this map.
composite_component_typesobjectAn map of the composite component types in the component type. Each composite component type's key must be unique to this map.
arnstringThe ARN of the component type.
creation_date_timestringThe date and time when the component type was created.
update_date_timestringThe last date and time when the component type was updated.
statusobjectThe current status of the component type.
is_abstractbooleanA Boolean value that specifies whether the component type is abstract.
is_schema_initializedbooleanA Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
tagsobjectA map of key-value pairs to associate with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the component_type resource, the following permissions are required: + +### Read +
+iottwinmaker:GetComponentType,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource
+ +### Update +
+iottwinmaker:GetComponentType,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource,
+iottwinmaker:UntagResource,
+iottwinmaker:UpdateComponentType
+ +### Delete +
+iottwinmaker:DeleteComponentType,
+iottwinmaker:GetComponentType,
+iottwinmaker:GetWorkspace
+ + +## Example +```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, +tags +FROM awscc.iottwinmaker.component_type +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkspaceId>' +AND data__Identifier = '<ComponentTypeId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md new file mode 100644 index 0000000000..6fc7691c6a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md @@ -0,0 +1,67 @@ +--- +title: component_types +hide_title: false +hide_table_of_contents: false +keywords: + - component_types + - 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 +--- +Retrieves a list of component_types in a region + +## Overview + + + + + +
Namecomponent_types
TypeResource
Descriptioncomponent_types
Idawscc.iottwinmaker.component_types
+ +## Fields + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace that contains the component type.
component_type_idstringThe ID of the component type.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the component_types resource, the following permissions are required: + +### Create +
+iottwinmaker:CreateComponentType,
+iottwinmaker:GetComponentType,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource
+ +### List +
+iottwinmaker:GetComponentType,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListComponentTypes,
+iottwinmaker:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +workspace_id, +component_type_id +FROM awscc.iottwinmaker.component_types +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md new file mode 100644 index 0000000000..637848dd25 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md @@ -0,0 +1,69 @@ +--- +title: entities +hide_title: false +hide_table_of_contents: false +keywords: + - entities + - 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 +--- +Retrieves a list of entities in a region + +## Overview + + + + + +
Nameentities
TypeResource
Descriptionentities
Idawscc.iottwinmaker.entities
+ +## Fields + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
entity_idstringThe ID of the entity.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the entities resource, the following permissions are required: + +### Create +
+iottwinmaker:GetWorkspace,
+iottwinmaker:CreateEntity,
+iottwinmaker:GetEntity,
+iottwinmaker:ListComponents,
+iottwinmaker:ListProperties,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource
+ +### List +
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:GetEntity,
+iottwinmaker:ListEntities
+ + +## Example +```sql +SELECT +region, +workspace_id, +entity_id +FROM awscc.iottwinmaker.entities +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md new file mode 100644 index 0000000000..8d9a31ea9b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md @@ -0,0 +1,105 @@ +--- +title: entity +hide_title: false +hide_table_of_contents: false +keywords: + - entity + - 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 +--- +Gets an individual entity resource + +## Overview + + + + + +
Nameentity
TypeResource
Descriptionentity
Idawscc.iottwinmaker.entity
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
entity_idstringThe ID of the entity.
entity_namestringThe name of the entity.
statusobjectThe current status of the entity.
has_child_entitiesbooleanA Boolean value that specifies whether the entity has child entities or not.
parent_entity_idstringThe ID of the parent entity.
arnstringThe ARN of the entity.
descriptionstringThe description of the entity.
creation_date_timestringThe date and time when the entity was created.
update_date_timestringThe last date and time when the entity was updated.
tagsobjectA key-value pair to associate with a resource.
workspace_idstringThe ID of the workspace.
componentsobjectA map that sets information about a component type.
composite_componentsobjectA map that sets information about a composite component.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the entity resource, the following permissions are required: + +### Read +
+iottwinmaker:GetComponentType,
+iottwinmaker:GetEntity,
+iottwinmaker:ListComponents,
+iottwinmaker:ListProperties,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListEntities,
+iottwinmaker:ListTagsForResource
+ +### Update +
+iottwinmaker:GetComponentType,
+iottwinmaker:GetEntity,
+iottwinmaker:ListComponents,
+iottwinmaker:ListProperties,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource,
+iottwinmaker:UntagResource,
+iottwinmaker:UpdateEntity,
+iottwinmaker:UpdateComponentType
+ +### Delete +
+iottwinmaker:GetEntity,
+iottwinmaker:GetWorkspace,
+iottwinmaker:DeleteEntity
+ + +## Example +```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, +components, +composite_components +FROM awscc.iottwinmaker.entity +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkspaceId>' +AND data__Identifier = '<EntityId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/index.md new file mode 100644 index 0000000000..ebe50b350f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/index.md @@ -0,0 +1,47 @@ +--- +title: iottwinmaker +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iottwinmaker service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+component_type
+component_types
+entities
+entity
+scene +
+
+scenes
+sync_job
+sync_jobs
+workspace
+workspaces +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/scene/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/scene/index.md new file mode 100644 index 0000000000..d4150da45d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/scene/index.md @@ -0,0 +1,93 @@ +--- +title: scene +hide_title: false +hide_table_of_contents: false +keywords: + - scene + - 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 +--- +Gets an individual scene resource + +## Overview + + + + + +
Namescene
TypeResource
Descriptionscene
Idawscc.iottwinmaker.scene
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
scene_idstringThe ID of the scene.
arnstringThe ARN of the scene.
descriptionstringThe description of the scene.
content_locationstringThe relative path that specifies the location of the content definition file.
creation_date_timestringThe date and time when the scene was created.
update_date_timestringThe date and time of the current update.
tagsobjectA key-value pair to associate with a resource.
workspace_idstringThe ID of the scene.
capabilitiesarrayA list of capabilities that the scene uses to render.
scene_metadataobjectA key-value pair of scene metadata for the scene.
generated_scene_metadataobjectA key-value pair of generated scene metadata for the scene.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scene resource, the following permissions are required: + +### Read +
+iottwinmaker:GetWorkspace,
+iottwinmaker:GetScene,
+iottwinmaker:ListTagsForResource
+ +### Update +
+iottwinmaker:GetScene,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource,
+iottwinmaker:UntagResource,
+iottwinmaker:UpdateScene
+ +### Delete +
+iottwinmaker:DeleteScene,
+iottwinmaker:GetScene,
+iottwinmaker:GetWorkspace
+ + +## Example +```sql +SELECT +region, +scene_id, +arn, +description, +content_location, +creation_date_time, +update_date_time, +tags, +workspace_id, +capabilities, +scene_metadata, +generated_scene_metadata +FROM awscc.iottwinmaker.scene +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkspaceId>' +AND data__Identifier = '<SceneId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md new file mode 100644 index 0000000000..1eeeebf7b7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md @@ -0,0 +1,66 @@ +--- +title: scenes +hide_title: false +hide_table_of_contents: false +keywords: + - scenes + - 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 +--- +Retrieves a list of scenes in a region + +## Overview + + + + + +
Namescenes
TypeResource
Descriptionscenes
Idawscc.iottwinmaker.scenes
+ +## Fields + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the scene.
scene_idstringThe ID of the scene.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scenes resource, the following permissions are required: + +### Create +
+iottwinmaker:CreateScene,
+iottwinmaker:GetScene,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource
+ +### List +
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:ListScenes
+ + +## Example +```sql +SELECT +region, +workspace_id, +scene_id +FROM awscc.iottwinmaker.scenes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md new file mode 100644 index 0000000000..4d1c2f3ae1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md @@ -0,0 +1,78 @@ +--- +title: sync_job +hide_title: false +hide_table_of_contents: false +keywords: + - sync_job + - 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 +--- +Gets an individual sync_job resource + +## Overview + + + + + +
Namesync_job
TypeResource
Descriptionsync_job
Idawscc.iottwinmaker.sync_job
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
sync_sourcestringThe source of the SyncJob.
sync_rolestringThe IAM Role that execute SyncJob.
creation_date_timestringThe date and time when the sync job was created.
update_date_timestringThe date and time when the sync job was updated.
arnstringThe ARN of the SyncJob.
statestringThe state of SyncJob.
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sync_job resource, the following permissions are required: + +### Read +
+iottwinmaker:GetSyncJob,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource
+ +### Delete +
+iottwinmaker:DeleteSyncJob,
+iottwinmaker:GetSyncJob,
+iottwinmaker:GetWorkspace
+ + +## Example +```sql +SELECT +region, +workspace_id, +sync_source, +sync_role, +creation_date_time, +update_date_time, +arn, +state, +tags +FROM awscc.iottwinmaker.sync_job +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkspaceId>' +AND data__Identifier = '<SyncSource>' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md new file mode 100644 index 0000000000..1c1f5f0f8a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md @@ -0,0 +1,67 @@ +--- +title: sync_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - sync_jobs + - 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 +--- +Retrieves a list of sync_jobs in a region + +## Overview + + + + + +
Namesync_jobs
TypeResource
Descriptionsync_jobs
Idawscc.iottwinmaker.sync_jobs
+ +## Fields + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
sync_sourcestringThe source of the SyncJob.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sync_jobs resource, the following permissions are required: + +### Create +
+iam:PassRole,
+iottwinmaker:CreateSyncJob,
+iottwinmaker:GetSyncJob,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource
+ +### List +
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListSyncJobs,
+iottwinmaker:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +workspace_id, +sync_source +FROM awscc.iottwinmaker.sync_jobs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md new file mode 100644 index 0000000000..658224b058 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md @@ -0,0 +1,83 @@ +--- +title: workspace +hide_title: false +hide_table_of_contents: false +keywords: + - workspace + - 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 +--- +Gets an individual workspace resource + +## Overview + + + + + +
Nameworkspace
TypeResource
Descriptionworkspace
Idawscc.iottwinmaker.workspace
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
arnstringThe ARN of the workspace.
descriptionstringThe description of the workspace.
rolestringThe ARN of the execution role associated with the workspace.
s3_locationstringThe ARN of the S3 bucket where resources associated with the workspace are stored.
creation_date_timestringThe date and time when the workspace was created.
update_date_timestringThe date and time of the current update.
tagsobjectA map of key-value pairs to associate with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workspace resource, the following permissions are required: + +### Read +
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource
+ +### Update +
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource,
+iottwinmaker:UntagResource,
+iottwinmaker:UpdateWorkspace
+ +### Delete +
+iottwinmaker:DeleteWorkspace,
+iottwinmaker:GetWorkspace
+ + +## Example +```sql +SELECT +region, +workspace_id, +arn, +description, +role, +s3_location, +creation_date_time, +update_date_time, +tags +FROM awscc.iottwinmaker.workspace +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkspaceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md new file mode 100644 index 0000000000..0929c9f963 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md @@ -0,0 +1,64 @@ +--- +title: workspaces +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces + - 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 +--- +Retrieves a list of workspaces in a region + +## Overview + + + + + +
Nameworkspaces
TypeResource
Descriptionworkspaces
Idawscc.iottwinmaker.workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workspaces resource, the following permissions are required: + +### Create +
+iam:PassRole,
+iottwinmaker:CreateWorkspace,
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:TagResource
+ +### List +
+iottwinmaker:GetWorkspace,
+iottwinmaker:ListTagsForResource,
+iottwinmaker:ListWorkspaces
+ + +## Example +```sql +SELECT +region, +workspace_id +FROM awscc.iottwinmaker.workspaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/destination/index.md b/docs/awscc-docs/providers/awscc/iotwireless/destination/index.md new file mode 100644 index 0000000000..8d3bfed17a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/destination/index.md @@ -0,0 +1,79 @@ +--- +title: destination +hide_title: false +hide_table_of_contents: false +keywords: + - destination + - 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 +--- +Gets an individual destination resource + +## Overview + + + + + +
Namedestination
TypeResource
Descriptiondestination
Idawscc.iotwireless.destination
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringUnique name of destination
expressionstringDestination expression
expression_typestringMust be RuleName
descriptionstringDestination description
tagsarrayA list of key-value pairs that contain metadata for the destination.
role_arnstringAWS role ARN that grants access
arnstringDestination arn. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the destination resource, the following permissions are required: + +### Read +
+iotwireless:GetDestination,
+iotwireless:ListTagsForResource
+ +### Update +
+iam:PassRole,
+iotwireless:UpdateDestination,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource
+ +### Delete +
+iotwireless:DeleteDestination
+ + +## Example +```sql +SELECT +region, +name, +expression, +expression_type, +description, +tags, +role_arn, +arn +FROM awscc.iotwireless.destination +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md b/docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md new file mode 100644 index 0000000000..7d2b84f52f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md @@ -0,0 +1,62 @@ +--- +title: destinations +hide_title: false +hide_table_of_contents: false +keywords: + - destinations + - 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 +--- +Retrieves a list of destinations in a region + +## Overview + + + + + +
Namedestinations
TypeResource
Descriptiondestinations
Idawscc.iotwireless.destinations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringUnique name of destination
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the destinations resource, the following permissions are required: + +### Create +
+iam:PassRole,
+iotwireless:CreateDestination,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListDestinations,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iotwireless.destinations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md b/docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md new file mode 100644 index 0000000000..27651864d6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md @@ -0,0 +1,68 @@ +--- +title: device_profile +hide_title: false +hide_table_of_contents: false +keywords: + - device_profile + - 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 +--- +Gets an individual device_profile resource + +## Overview + + + + + +
Namedevice_profile
TypeResource
Descriptiondevice_profile
Idawscc.iotwireless.device_profile
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringName of service profile
lo_ra_wa_nobjectLoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation
tagsarrayA list of key-value pairs that contain metadata for the device profile.
arnstringService profile Arn. Returned after successful create.
idstringService profile Id. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the device_profile resource, the following permissions are required: + +### Read +
+iotwireless:GetDeviceProfile,
+iotwireless:ListTagsForResource
+ +### Delete +
+iotwireless:DeleteDeviceProfile
+ + +## Example +```sql +SELECT +region, +name, +lo_ra_wa_n, +tags, +arn, +id +FROM awscc.iotwireless.device_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md b/docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md new file mode 100644 index 0000000000..529d43cf07 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md @@ -0,0 +1,61 @@ +--- +title: device_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - device_profiles + - 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 +--- +Retrieves a list of device_profiles in a region + +## Overview + + + + + +
Namedevice_profiles
TypeResource
Descriptiondevice_profiles
Idawscc.iotwireless.device_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
idstringService profile Id. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the device_profiles resource, the following permissions are required: + +### Create +
+iotwireless:CreateDeviceProfile,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListDeviceProfiles,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.device_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md b/docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md new file mode 100644 index 0000000000..52ea5d75bd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md @@ -0,0 +1,95 @@ +--- +title: fuota_task +hide_title: false +hide_table_of_contents: false +keywords: + - fuota_task + - 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 +--- +Gets an individual fuota_task resource + +## Overview + + + + + +
Namefuota_task
TypeResource
Descriptionfuota_task
Idawscc.iotwireless.fuota_task
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of FUOTA task
descriptionstringFUOTA task description
lo_ra_wa_nobjectFUOTA task LoRaWAN
firmware_update_imagestringFUOTA task firmware update image binary S3 link
firmware_update_rolestringFUOTA task firmware IAM role for reading S3
arnstringFUOTA task arn. Returned after successful create.
idstringFUOTA task id. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the FUOTA task.
fuota_task_statusstringFUOTA task status. Returned after successful read.
associate_wireless_devicestringWireless device to associate. Only for update request.
disassociate_wireless_devicestringWireless device to disassociate. Only for update request.
associate_multicast_groupstringMulticast group to associate. Only for update request.
disassociate_multicast_groupstringMulticast group to disassociate. Only for update request.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fuota_task resource, the following permissions are required: + +### Read +
+iotwireless:GetFuotaTask,
+iotwireless:ListTagsForResource
+ +### Update +
+iam:PassRole,
+iotwireless:UpdateFuotaTask,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource,
+iotwireless:AssociateMulticastGroupWithFuotaTask,
+iotwireless:DisassociateMulticastGroupFromFuotaTask,
+iotwireless:AssociateWirelessDeviceWithFuotaTask,
+iotwireless:DisassociateWirelessDeviceFromFuotaTask
+ +### Delete +
+iotwireless:DeleteFuotaTask
+ + +## Example +```sql +SELECT +region, +name, +description, +lo_ra_wa_n, +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 awscc.iotwireless.fuota_task +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md b/docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md new file mode 100644 index 0000000000..3ecd480ef1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md @@ -0,0 +1,63 @@ +--- +title: fuota_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - fuota_tasks + - 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 +--- +Retrieves a list of fuota_tasks in a region + +## Overview + + + + + +
Namefuota_tasks
TypeResource
Descriptionfuota_tasks
Idawscc.iotwireless.fuota_tasks
+ +## Fields + + + + + +
NameDatatypeDescription
idstringFUOTA task id. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fuota_tasks resource, the following permissions are required: + +### Create +
+iotwireless:CreateFuotaTask,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource,
+iam:GetRole,
+iam:PassRole
+ +### List +
+iotwireless:ListFuotaTasks,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.fuota_tasks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/index.md b/docs/awscc-docs/providers/awscc/iotwireless/index.md new file mode 100644 index 0000000000..d9b13efc82 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/index.md @@ -0,0 +1,59 @@ +--- +title: iotwireless +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The iotwireless service documentation. + +:::info Service Summary + +
+
+total resources: 22
+total selectable resources: 22
+total methods: 22
+
+
+ +::: + +## Resources +
+
+destination
+destinations
+device_profile
+device_profiles
+fuota_task
+fuota_tasks
+multicast_group
+multicast_groups
+network_analyzer_configuration
+network_analyzer_configurations
+partner_account +
+
+partner_accounts
+service_profile
+service_profiles
+task_definition
+task_definitions
+wireless_device
+wireless_device_import_task
+wireless_device_import_tasks
+wireless_devices
+wireless_gateway
+wireless_gateways +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/iotwireless/multicast_group/index.md b/docs/awscc-docs/providers/awscc/iotwireless/multicast_group/index.md new file mode 100644 index 0000000000..e65d7484fe --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/multicast_group/index.md @@ -0,0 +1,84 @@ +--- +title: multicast_group +hide_title: false +hide_table_of_contents: false +keywords: + - multicast_group + - 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 +--- +Gets an individual multicast_group resource + +## Overview + + + + + +
Namemulticast_group
TypeResource
Descriptionmulticast_group
Idawscc.iotwireless.multicast_group
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of Multicast group
descriptionstringMulticast group description
lo_ra_wa_nobjectMulticast group LoRaWAN
arnstringMulticast group arn. Returned after successful create.
idstringMulticast group id. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the Multicast group.
statusstringMulticast group status. Returned after successful read.
associate_wireless_devicestringWireless device to associate. Only for update request.
disassociate_wireless_devicestringWireless device to disassociate. Only for update request.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multicast_group resource, the following permissions are required: + +### Read +
+iotwireless:GetMulticastGroup,
+iotwireless:ListTagsForResource
+ +### Update +
+iotwireless:UpdateMulticastGroup,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource,
+iotwireless:AssociateWirelessDeviceWithMulticastGroup,
+iotwireless:DisassociateWirelessDeviceFromMulticastGroup
+ +### Delete +
+iotwireless:DeleteMulticastGroup
+ + +## Example +```sql +SELECT +region, +name, +description, +lo_ra_wa_n, +arn, +id, +tags, +status, +associate_wireless_device, +disassociate_wireless_device +FROM awscc.iotwireless.multicast_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md b/docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md new file mode 100644 index 0000000000..ca1a3e4e88 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md @@ -0,0 +1,61 @@ +--- +title: multicast_groups +hide_title: false +hide_table_of_contents: false +keywords: + - multicast_groups + - 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 +--- +Retrieves a list of multicast_groups in a region + +## Overview + + + + + +
Namemulticast_groups
TypeResource
Descriptionmulticast_groups
Idawscc.iotwireless.multicast_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstringMulticast group id. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multicast_groups resource, the following permissions are required: + +### Create +
+iotwireless:CreateMulticastGroup,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListMulticastGroups,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.multicast_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configuration/index.md b/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configuration/index.md new file mode 100644 index 0000000000..d697740318 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configuration/index.md @@ -0,0 +1,78 @@ +--- +title: network_analyzer_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - network_analyzer_configuration + - 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 +--- +Gets an individual network_analyzer_configuration resource + +## Overview + + + + + +
Namenetwork_analyzer_configuration
TypeResource
Descriptionnetwork_analyzer_configuration
Idawscc.iotwireless.network_analyzer_configuration
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the network analyzer configuration
descriptionstringThe description of the new resource
trace_contentobjectTrace content for your wireless gateway and wireless device resources
wireless_devicesarrayList of wireless gateway resources that have been added to the network analyzer configuration
wireless_gatewaysarrayList of wireless gateway resources that have been added to the network analyzer configuration
arnstringArn for network analyzer configuration, Returned upon successful create.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the network_analyzer_configuration resource, the following permissions are required: + +### Read +
+iotwireless:GetNetworkAnalyzerConfiguration,
+iotwireless:ListTagsForResource
+ +### Update +
+iotwireless:UpdateNetworkAnalyzerConfiguration,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource
+ +### Delete +
+iotwireless:DeleteNetworkAnalyzerConfiguration
+ + +## Example +```sql +SELECT +region, +name, +description, +trace_content, +wireless_devices, +wireless_gateways, +arn, +tags +FROM awscc.iotwireless.network_analyzer_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configurations/index.md b/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configurations/index.md new file mode 100644 index 0000000000..3dd392e2db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configurations/index.md @@ -0,0 +1,61 @@ +--- +title: network_analyzer_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - network_analyzer_configurations + - 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 +--- +Retrieves a list of network_analyzer_configurations in a region + +## Overview + + + + + +
Namenetwork_analyzer_configurations
TypeResource
Descriptionnetwork_analyzer_configurations
Idawscc.iotwireless.network_analyzer_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the network analyzer configuration
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the network_analyzer_configurations resource, the following permissions are required: + +### Create +
+iotwireless:CreateNetworkAnalyzerConfiguration,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListNetworkAnalyzerConfigurations,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.iotwireless.network_analyzer_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md b/docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md new file mode 100644 index 0000000000..a0f4999cea --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md @@ -0,0 +1,82 @@ +--- +title: partner_account +hide_title: false +hide_table_of_contents: false +keywords: + - partner_account + - 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 +--- +Gets an individual partner_account resource + +## Overview + + + + + +
Namepartner_account
TypeResource
Descriptionpartner_account
Idawscc.iotwireless.partner_account
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
sidewalkobjectThe Sidewalk account credentials.
partner_account_idstringThe partner account ID to disassociate from the AWS account
partner_typestringThe partner type
sidewalk_responseobjectThe Sidewalk account credentials.
account_linkedbooleanWhether the partner account is linked to the AWS account.
sidewalk_updateobjectThe Sidewalk account credentials.
fingerprintstringThe fingerprint of the Sidewalk application server private key.
arnstringPartnerAccount arn. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the destination.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the partner_account resource, the following permissions are required: + +### Read +
+iotwireless:GetPartnerAccount,
+iotwireless:ListTagsForResource
+ +### Update +
+iotwireless:UpdatePartnerAccount,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource
+ +### Delete +
+iotwireless:DisassociateAwsAccountFromPartnerAccount
+ + +## Example +```sql +SELECT +region, +sidewalk, +partner_account_id, +partner_type, +sidewalk_response, +account_linked, +sidewalk_update, +fingerprint, +arn, +tags +FROM awscc.iotwireless.partner_account +WHERE region = 'us-east-1' +AND data__Identifier = '<PartnerAccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md b/docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md new file mode 100644 index 0000000000..6a5c4f42e0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md @@ -0,0 +1,61 @@ +--- +title: partner_accounts +hide_title: false +hide_table_of_contents: false +keywords: + - partner_accounts + - 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 +--- +Retrieves a list of partner_accounts in a region + +## Overview + + + + + +
Namepartner_accounts
TypeResource
Descriptionpartner_accounts
Idawscc.iotwireless.partner_accounts
+ +## Fields + + + + + +
NameDatatypeDescription
partner_account_idstringThe partner account ID to disassociate from the AWS account
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the partner_accounts resource, the following permissions are required: + +### Create +
+iotwireless:AssociateAwsAccountWithPartnerAccount,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListPartnerAccounts,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +partner_account_id +FROM awscc.iotwireless.partner_accounts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md b/docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md new file mode 100644 index 0000000000..5bf175630a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md @@ -0,0 +1,68 @@ +--- +title: service_profile +hide_title: false +hide_table_of_contents: false +keywords: + - service_profile + - 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 +--- +Gets an individual service_profile resource + +## Overview + + + + + +
Nameservice_profile
TypeResource
Descriptionservice_profile
Idawscc.iotwireless.service_profile
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringName of service profile
lo_ra_wa_nobjectLoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation
tagsarrayA list of key-value pairs that contain metadata for the service profile.
arnstringService profile Arn. Returned after successful create.
idstringService profile Id. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_profile resource, the following permissions are required: + +### Read +
+iotwireless:GetServiceProfile,
+iotwireless:ListTagsForResource
+ +### Delete +
+iotwireless:DeleteServiceProfile
+ + +## Example +```sql +SELECT +region, +name, +lo_ra_wa_n, +tags, +arn, +id +FROM awscc.iotwireless.service_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md b/docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md new file mode 100644 index 0000000000..f396c300bd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md @@ -0,0 +1,61 @@ +--- +title: service_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - service_profiles + - 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 +--- +Retrieves a list of service_profiles in a region + +## Overview + + + + + +
Nameservice_profiles
TypeResource
Descriptionservice_profiles
Idawscc.iotwireless.service_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
idstringService profile Id. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_profiles resource, the following permissions are required: + +### Create +
+iotwireless:CreateServiceProfile,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListServiceProfiles,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.service_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md b/docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md new file mode 100644 index 0000000000..148f367513 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md @@ -0,0 +1,74 @@ +--- +title: task_definition +hide_title: false +hide_table_of_contents: false +keywords: + - task_definition + - 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 +--- +Gets an individual task_definition resource + +## Overview + + + + + +
Nametask_definition
TypeResource
Descriptiontask_definition
Idawscc.iotwireless.task_definition
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the new resource.
auto_create_tasksbooleanWhether 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.
updateobjectInformation about the gateways to update.
lo_ra_wa_nupdate_gateway_task_entryobjectThe list of task definitions.
idstringThe ID of the new wireless gateway task definition
task_definition_typestringA filter to list only the wireless gateway task definitions that use this task definition type
arnstringTaskDefinition arn. Returned after successful create.
tagsarrayA list of key-value pairs that contain metadata for the destination.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_definition resource, the following permissions are required: + +### Read +
+iotwireless:GetWirelessGatewayTaskDefinition,
+iotwireless:ListTagsForResource
+ +### Delete +
+iotwireless:DeleteWirelessGatewayTaskDefinition
+ + +## Example +```sql +SELECT +region, +name, +auto_create_tasks, +update, +lo_ra_wa_nupdate_gateway_task_entry, +id, +task_definition_type, +arn, +tags +FROM awscc.iotwireless.task_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md b/docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md new file mode 100644 index 0000000000..d482f05285 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md @@ -0,0 +1,63 @@ +--- +title: task_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - task_definitions + - 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 +--- +Retrieves a list of task_definitions in a region + +## Overview + + + + + +
Nametask_definitions
TypeResource
Descriptiontask_definitions
Idawscc.iotwireless.task_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the new wireless gateway task definition
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the task_definitions resource, the following permissions are required: + +### Create +
+iotwireless:CreateWirelessGatewayTaskDefinition,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource,
+iam:GetRole,
+iam:PassRole
+ +### List +
+iotwireless:ListWirelessGatewayTaskDefinitions,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.task_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md new file mode 100644 index 0000000000..b73844b3fd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md @@ -0,0 +1,90 @@ +--- +title: wireless_device +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device + - 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 +--- +Gets an individual wireless_device resource + +## Overview + + + + + +
Namewireless_device
TypeResource
Descriptionwireless_device
Idawscc.iotwireless.wireless_device
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
typestringWireless device type, currently only Sidewalk and LoRa
namestringWireless device name
descriptionstringWireless device description
destination_namestringWireless device destination name
lo_ra_wa_nobjectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device.
tagsarrayA list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed.
arnstringWireless device arn. Returned after successful create.
idstringWireless device Id. Returned after successful create.
thing_arnstringThing arn. Passed into update to associate Thing with Wireless device.
thing_namestringThing Arn. If there is a Thing created, this can be returned with a Get call.
last_uplink_received_atstringThe date and time when the most recent uplink was received.
positioningstringFPort values for the GNSS, stream, and ClockSync functions of the positioning information.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wireless_device resource, the following permissions are required: + +### Read +
+iotwireless:GetWirelessDevice,
+iotwireless:ListTagsForResource
+ +### Update +
+iotwireless:UpdateWirelessDevice,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource,
+iotwireless:AssociateWirelessDeviceWithThing
+ +### Delete +
+iotwireless:DeleteWirelessDevice,
+iotwireless:DisassociateWirelessDeviceFromThing
+ + +## Example +```sql +SELECT +region, +type, +name, +description, +destination_name, +lo_ra_wa_n, +tags, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at, +positioning +FROM awscc.iotwireless.wireless_device +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_task/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_task/index.md new file mode 100644 index 0000000000..619a70e183 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_task/index.md @@ -0,0 +1,89 @@ +--- +title: wireless_device_import_task +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_import_task + - 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 +--- +Gets an individual wireless_device_import_task resource + +## Overview + + + + + +
Namewireless_device_import_task
TypeResource
Descriptionwireless_device_import_task
Idawscc.iotwireless.wireless_device_import_task
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringId for Wireless Device Import Task, Returned upon successful start.
arnstringArn for Wireless Device Import Task, Returned upon successful start.
destination_namestringDestination Name for import task
creation_datestringCreationDate for import task
sidewalkobjectsidewalk contain file for created device and role
statusstringStatus for import task
status_reasonstringStatusReason for import task
initialized_imported_devices_countintegerInitialized Imported Devices Count
pending_imported_devices_countintegerPending Imported Devices Count
onboarded_imported_devices_countintegerOnboarded Imported Devices Count
failed_imported_devices_countintegerFailed Imported Devices Count
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wireless_device_import_task resource, the following permissions are required: + +### Read +
+iotwireless:GetWirelessDeviceImportTask,
+iotwireless:ListTagsForResource
+ +### Update +
+iotwireless:UpdateWirelessDeviceImportTask,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource,
+iam:PassRole
+ +### Delete +
+iotwireless:DeleteWirelessDeviceImportTask
+ + +## Example +```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, +tags +FROM awscc.iotwireless.wireless_device_import_task +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_tasks/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_tasks/index.md new file mode 100644 index 0000000000..cd4e04eb12 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_tasks/index.md @@ -0,0 +1,63 @@ +--- +title: wireless_device_import_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_import_tasks + - 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 +--- +Retrieves a list of wireless_device_import_tasks in a region + +## Overview + + + + + +
Namewireless_device_import_tasks
TypeResource
Descriptionwireless_device_import_tasks
Idawscc.iotwireless.wireless_device_import_tasks
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId for Wireless Device Import Task, Returned upon successful start.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wireless_device_import_tasks resource, the following permissions are required: + +### Create +
+iotwireless:StartWirelessDeviceImportTask,
+iotwireless:StartSingleWirelessDeviceImportTask,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource,
+iam:PassRole
+ +### List +
+iotwireless:ListWirelessDeviceImportTasks,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.wireless_device_import_tasks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md new file mode 100644 index 0000000000..a4824ba618 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md @@ -0,0 +1,61 @@ +--- +title: wireless_devices +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_devices + - 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 +--- +Retrieves a list of wireless_devices in a region + +## Overview + + + + + +
Namewireless_devices
TypeResource
Descriptionwireless_devices
Idawscc.iotwireless.wireless_devices
+ +## Fields + + + + + +
NameDatatypeDescription
idstringWireless device Id. Returned after successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wireless_devices resource, the following permissions are required: + +### Create +
+iotwireless:CreateWirelessDevice,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListWirelessDevices,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.wireless_devices +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md new file mode 100644 index 0000000000..031c4350ff --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md @@ -0,0 +1,84 @@ +--- +title: wireless_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_gateway + - 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 +--- +Gets an individual wireless_gateway resource + +## Overview + + + + + +
Namewireless_gateway
TypeResource
Descriptionwireless_gateway
Idawscc.iotwireless.wireless_gateway
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of Wireless Gateway.
descriptionstringDescription of Wireless Gateway.
tagsarrayA list of key-value pairs that contain metadata for the gateway.
lo_ra_wa_nobjectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway.
arnstringArn for Wireless Gateway. Returned upon successful create.
idstringId for Wireless Gateway. Returned upon successful create.
thing_arnstringThing Arn. Passed into Update to associate a Thing with the Wireless Gateway.
thing_namestringThing Name. If there is a Thing created, this can be returned with a Get call.
last_uplink_received_atstringThe date and time when the most recent uplink was received.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wireless_gateway resource, the following permissions are required: + +### Read +
+iotwireless:GetWirelessGateway,
+iotwireless:ListTagsForResource
+ +### Update +
+iotwireless:UpdateWirelessGateway,
+iotwireless:UntagResource,
+iotwireless:ListTagsForResource,
+iotwireless:AssociateWirelessGatewayWithThing
+ +### Delete +
+iotwireless:DeleteWirelessGateway,
+iotwireless:DisassociateWirelessGatewayFromThing
+ + +## Example +```sql +SELECT +region, +name, +description, +tags, +lo_ra_wa_n, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at +FROM awscc.iotwireless.wireless_gateway +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md new file mode 100644 index 0000000000..23d68971f2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md @@ -0,0 +1,61 @@ +--- +title: wireless_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_gateways + - 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 +--- +Retrieves a list of wireless_gateways in a region + +## Overview + + + + + +
Namewireless_gateways
TypeResource
Descriptionwireless_gateways
Idawscc.iotwireless.wireless_gateways
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId for Wireless Gateway. Returned upon successful create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the wireless_gateways resource, the following permissions are required: + +### Create +
+iotwireless:CreateWirelessGateway,
+iotwireless:TagResource,
+iotwireless:ListTagsForResource
+ +### List +
+iotwireless:ListWirelessGateways,
+iotwireless:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.iotwireless.wireless_gateways +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/channel/index.md b/docs/awscc-docs/providers/awscc/ivs/channel/index.md new file mode 100644 index 0000000000..96eac5cf1f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/channel/index.md @@ -0,0 +1,89 @@ +--- +title: channel +hide_title: false +hide_table_of_contents: false +keywords: + - channel + - 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 +--- +Gets an individual channel resource + +## Overview + + + + + +
Namechannel
TypeResource
Descriptionchannel
Idawscc.ivs.channel
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringChannel ARN is automatically generated on creation and assigned as the unique identifier.
namestringChannel
authorizedbooleanWhether the channel is authorized.
insecure_ingestbooleanWhether the channel allows insecure ingest.
latency_modestringChannel latency mode.
typestringChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
playback_urlstringChannel Playback URL.
ingest_endpointstringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
recording_configuration_arnstringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
presetstringOptional 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 ("").
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +
+ivs:GetChannel,
+ivs:ListTagsForResource
+ +### Update +
+ivs:GetChannel,
+ivs:UpdateChannel,
+ivs:TagResource,
+ivs:UnTagResource,
+ivs:ListTagsForResource
+ +### Delete +
+ivs:DeleteChannel,
+ivs:UnTagResource
+ + +## Example +```sql +SELECT +region, +arn, +name, +authorized, +insecure_ingest, +latency_mode, +type, +tags, +playback_url, +ingest_endpoint, +recording_configuration_arn, +preset +FROM awscc.ivs.channel +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/channels/index.md b/docs/awscc-docs/providers/awscc/ivs/channels/index.md new file mode 100644 index 0000000000..bfc51aa2d3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/channels/index.md @@ -0,0 +1,60 @@ +--- +title: channels +hide_title: false +hide_table_of_contents: false +keywords: + - channels + - 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 +--- +Retrieves a list of channels in a region + +## Overview + + + + + +
Namechannels
TypeResource
Descriptionchannels
Idawscc.ivs.channels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringChannel ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +
+ivs:CreateChannel,
+ivs:TagResource
+ +### List +
+ivs:ListChannels,
+ivs:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ivs.channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/index.md b/docs/awscc-docs/providers/awscc/ivs/index.md new file mode 100644 index 0000000000..6193a087b7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/index.md @@ -0,0 +1,47 @@ +--- +title: ivs +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ivs service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+channel
+channels
+playback_key_pair
+playback_key_pairs
+recording_configuration +
+
+recording_configurations
+stage
+stages
+stream_key
+stream_keys +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ivs/playback_key_pair/index.md b/docs/awscc-docs/providers/awscc/ivs/playback_key_pair/index.md new file mode 100644 index 0000000000..6d647ff317 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/playback_key_pair/index.md @@ -0,0 +1,75 @@ +--- +title: playback_key_pair +hide_title: false +hide_table_of_contents: false +keywords: + - playback_key_pair + - 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 +--- +Gets an individual playback_key_pair resource + +## Overview + + + + + +
Nameplayback_key_pair
TypeResource
Descriptionplayback_key_pair
Idawscc.ivs.playback_key_pair
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringAn 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.
public_key_materialstringThe public portion of a customer-generated key pair.
fingerprintstringKey-pair identifier.
arnstringKey-pair identifier.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the playback_key_pair resource, the following permissions are required: + +### Read +
+ivs:GetPlaybackKeyPair
+ +### Update +
+ivs:GetPlaybackKeyPair,
+ivs:ListTagsForResource,
+ivs:UntagResource,
+ivs:TagResource
+ +### Delete +
+ivs:DeletePlaybackKeyPair,
+ivs:UntagResource
+ + +## Example +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tags +FROM awscc.ivs.playback_key_pair +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/playback_key_pairs/index.md b/docs/awscc-docs/providers/awscc/ivs/playback_key_pairs/index.md new file mode 100644 index 0000000000..c82999b1d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/playback_key_pairs/index.md @@ -0,0 +1,60 @@ +--- +title: playback_key_pairs +hide_title: false +hide_table_of_contents: false +keywords: + - playback_key_pairs + - 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 +--- +Retrieves a list of playback_key_pairs in a region + +## Overview + + + + + +
Nameplayback_key_pairs
TypeResource
Descriptionplayback_key_pairs
Idawscc.ivs.playback_key_pairs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringKey-pair identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the playback_key_pairs resource, the following permissions are required: + +### Create +
+ivs:ImportPlaybackKeyPair,
+ivs:TagResource
+ +### List +
+ivs:ListPlaybackKeyPairs,
+ivs:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ivs.playback_key_pairs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md b/docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md new file mode 100644 index 0000000000..2d808524c5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md @@ -0,0 +1,89 @@ +--- +title: recording_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - recording_configuration + - 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 +--- +Gets an individual recording_configuration resource + +## Overview + + + + + +
Namerecording_configuration
TypeResource
Descriptionrecording_configuration
Idawscc.ivs.recording_configuration
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
namestringRecording Configuration Name.
statestringRecording Configuration State.
recording_reconnect_window_secondsintegerRecording Reconnect Window Seconds. (0 means disabled)
destination_configurationobject
tagsarrayA list of key-value pairs that contain metadata for the asset model.
thumbnail_configurationobject
rendition_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the recording_configuration resource, the following permissions are required: + +### Read +
+ivs:GetRecordingConfiguration,
+s3:GetBucketLocation,
+ivs:ListTagsForResource
+ +### Update +
+ivs:GetRecordingConfiguration,
+sts:AssumeRole,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy,
+iam:AttachRolePolicy,
+s3:ListBucket,
+ivs:TagResource,
+ivs:UntagResource,
+ivs:ListTagsForResource
+ +### Delete +
+ivs:DeleteRecordingConfiguration,
+ivs:UntagResource,
+iam:CreateServiceLinkedRole
+ + +## Example +```sql +SELECT +region, +arn, +name, +state, +recording_reconnect_window_seconds, +destination_configuration, +tags, +thumbnail_configuration, +rendition_configuration +FROM awscc.ivs.recording_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md b/docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md new file mode 100644 index 0000000000..12cba73e6b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md @@ -0,0 +1,68 @@ +--- +title: recording_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - recording_configurations + - 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 +--- +Retrieves a list of recording_configurations in a region + +## Overview + + + + + +
Namerecording_configurations
TypeResource
Descriptionrecording_configurations
Idawscc.ivs.recording_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the recording_configurations resource, the following permissions are required: + +### Create +
+ivs:CreateRecordingConfiguration,
+ivs:GetRecordingConfiguration,
+ivs:TagResource,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy,
+iam:AttachRolePolicy,
+s3:ListBucket,
+s3:GetBucketLocation,
+cloudformation:ListExports
+ +### List +
+ivs:ListRecordingConfigurations,
+s3:GetBucketLocation,
+ivs:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ivs.recording_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/stage/index.md b/docs/awscc-docs/providers/awscc/ivs/stage/index.md new file mode 100644 index 0000000000..7d6b015565 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/stage/index.md @@ -0,0 +1,75 @@ +--- +title: stage +hide_title: false +hide_table_of_contents: false +keywords: + - stage + - 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 +--- +Gets an individual stage resource + +## Overview + + + + + +
Namestage
TypeResource
Descriptionstage
Idawscc.ivs.stage
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstringStage ARN is automatically generated on creation and assigned as the unique identifier.
namestringStage name
tagsarrayAn array of key-value pairs to apply to this resource.
active_session_idstringID of the active session within the stage.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stage resource, the following permissions are required: + +### Read +
+ivs:GetStage,
+ivs:ListTagsForResource
+ +### Update +
+ivs:GetStage,
+ivs:UpdateStage,
+ivs:TagResource,
+ivs:UnTagResource,
+ivs:ListTagsForResource
+ +### Delete +
+ivs:DeleteStage,
+ivs:UnTagResource
+ + +## Example +```sql +SELECT +region, +arn, +name, +tags, +active_session_id +FROM awscc.ivs.stage +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/stages/index.md b/docs/awscc-docs/providers/awscc/ivs/stages/index.md new file mode 100644 index 0000000000..6561424706 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/stages/index.md @@ -0,0 +1,62 @@ +--- +title: stages +hide_title: false +hide_table_of_contents: false +keywords: + - stages + - 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 +--- +Retrieves a list of stages in a region + +## Overview + + + + + +
Namestages
TypeResource
Descriptionstages
Idawscc.ivs.stages
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringStage ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stages resource, the following permissions are required: + +### Create +
+ivs:CreateStage,
+ivs:GetStage,
+ivs:TagResource,
+ivs:ListTagsForResource
+ +### List +
+ivs:ListStages,
+ivs:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ivs.stages +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/stream_key/index.md b/docs/awscc-docs/providers/awscc/ivs/stream_key/index.md new file mode 100644 index 0000000000..06b84a3b30 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/stream_key/index.md @@ -0,0 +1,74 @@ +--- +title: stream_key +hide_title: false +hide_table_of_contents: false +keywords: + - stream_key + - 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 +--- +Gets an individual stream_key resource + +## Overview + + + + + +
Namestream_key
TypeResource
Descriptionstream_key
Idawscc.ivs.stream_key
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
channel_arnstringChannel ARN for the stream.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
valuestringStream-key value.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stream_key resource, the following permissions are required: + +### Read +
+ivs:GetStreamKey,
+ivs:ListTagsForResource
+ +### Update +
+ivs:GetStreamKey,
+ivs:TagResource,
+ivs:UntagResource,
+ivs:ListTagsForResource
+ +### Delete +
+ivs:DeleteStreamKey,
+ivs:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +channel_arn, +tags, +value +FROM awscc.ivs.stream_key +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md b/docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md new file mode 100644 index 0000000000..1a4c7a6c83 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md @@ -0,0 +1,61 @@ +--- +title: stream_keys +hide_title: false +hide_table_of_contents: false +keywords: + - stream_keys + - 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 +--- +Retrieves a list of stream_keys in a region + +## Overview + + + + + +
Namestream_keys
TypeResource
Descriptionstream_keys
Idawscc.ivs.stream_keys
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stream_keys resource, the following permissions are required: + +### Create +
+ivs:TagResource,
+ivs:UntagResource,
+ivs:CreateStreamKey
+ +### List +
+ivs:ListStreamKeys,
+ivs:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ivs.stream_keys +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ivschat/index.md b/docs/awscc-docs/providers/awscc/ivschat/index.md new file mode 100644 index 0000000000..d271e9d460 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivschat/index.md @@ -0,0 +1,41 @@ +--- +title: ivschat +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ivschat service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+logging_configuration
+logging_configurations +
+
+room
+rooms +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ivschat/logging_configuration/index.md b/docs/awscc-docs/providers/awscc/ivschat/logging_configuration/index.md new file mode 100644 index 0000000000..592560fcbf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivschat/logging_configuration/index.md @@ -0,0 +1,95 @@ +--- +title: logging_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configuration + - 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 +--- +Gets an individual logging_configuration resource + +## Overview + + + + + +
Namelogging_configuration
TypeResource
Descriptionlogging_configuration
Idawscc.ivschat.logging_configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
idstringThe system-generated ID of the logging configuration.
destination_configurationobject
namestringThe name of the logging configuration. The value does not need to be unique.
statestringThe state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the logging_configuration resource, the following permissions are required: + +### Read +
+ivschat:GetLoggingConfiguration,
+ivschat:ListTagsForResource
+ +### Update +
+ivschat:UpdateLoggingConfiguration,
+ivschat:GetLoggingConfiguration,
+ivschat:TagResource,
+ivschat:UnTagResource,
+ivschat:ListTagsForResource,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+iam:CreateServiceLinkedRole,
+firehose:TagDeliveryStream
+ +### Delete +
+ivschat:DeleteLoggingConfiguration,
+ivschat:GetLoggingConfiguration,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+ivschat:UntagResource,
+logs:GetLogDelivery
+ + +## Example +```sql +SELECT +region, +arn, +id, +destination_configuration, +name, +state, +tags +FROM awscc.ivschat.logging_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md b/docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md new file mode 100644 index 0000000000..fce6d182ed --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md @@ -0,0 +1,69 @@ +--- +title: logging_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations + - 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 +--- +Retrieves a list of logging_configurations in a region + +## Overview + + + + + +
Namelogging_configurations
TypeResource
Descriptionlogging_configurations
Idawscc.ivschat.logging_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the logging_configurations resource, the following permissions are required: + +### Create +
+ivschat:CreateLoggingConfiguration,
+ivschat:GetLoggingConfiguration,
+logs:CreateLogDelivery,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+iam:CreateServiceLinkedRole,
+firehose:TagDeliveryStream,
+ivschat:TagResource
+ +### List +
+ivschat:ListLoggingConfigurations,
+ivschat:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ivschat.logging_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ivschat/room/index.md b/docs/awscc-docs/providers/awscc/ivschat/room/index.md new file mode 100644 index 0000000000..00fbdab4c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivschat/room/index.md @@ -0,0 +1,82 @@ +--- +title: room +hide_title: false +hide_table_of_contents: false +keywords: + - room + - 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 +--- +Gets an individual room resource + +## Overview + + + + + +
Nameroom
TypeResource
Descriptionroom
Idawscc.ivschat.room
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstringRoom ARN is automatically generated on creation and assigned as the unique identifier.
idstringThe system-generated ID of the room.
namestringThe name of the room. The value does not need to be unique.
logging_configuration_identifiersarrayArray of logging configuration identifiers attached to the room.
maximum_message_lengthintegerThe maximum number of characters in a single message.
maximum_message_rate_per_secondintegerThe maximum number of messages per second that can be sent to the room.
message_review_handlerobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the room resource, the following permissions are required: + +### Read +
+ivschat:GetRoom,
+ivschat:ListTagsForResource
+ +### Update +
+ivschat:UpdateRoom,
+ivschat:TagResource,
+ivschat:UnTagResource,
+ivschat:ListTagsForResource
+ +### Delete +
+ivschat:DeleteRoom,
+ivschat:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +id, +name, +logging_configuration_identifiers, +maximum_message_length, +maximum_message_rate_per_second, +message_review_handler, +tags +FROM awscc.ivschat.room +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ivschat/rooms/index.md b/docs/awscc-docs/providers/awscc/ivschat/rooms/index.md new file mode 100644 index 0000000000..baeb4057b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ivschat/rooms/index.md @@ -0,0 +1,60 @@ +--- +title: rooms +hide_title: false +hide_table_of_contents: false +keywords: + - rooms + - 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 +--- +Retrieves a list of rooms in a region + +## Overview + + + + + +
Namerooms
TypeResource
Descriptionrooms
Idawscc.ivschat.rooms
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringRoom ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rooms resource, the following permissions are required: + +### Create +
+ivschat:CreateRoom,
+ivschat:TagResource
+ +### List +
+ivschat:ListRooms,
+ivschat:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ivschat.rooms +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md b/docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md new file mode 100644 index 0000000000..e45efea5ae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md @@ -0,0 +1,102 @@ +--- +title: connector +hide_title: false +hide_table_of_contents: false +keywords: + - connector + - 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 +--- +Gets an individual connector resource + +## Overview + + + + + +
Nameconnector
TypeResource
Descriptionconnector
Idawscc.kafkaconnect.connector
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
capacityobject
connector_arnstringAmazon Resource Name for the created Connector.
connector_configurationobjectThe configuration for the connector.
connector_descriptionstringA summary description of the connector.
connector_namestringThe name of the connector.
kafka_clusterobject
kafka_cluster_client_authenticationobject
kafka_cluster_encryption_in_transitobject
kafka_connect_versionstringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
log_deliveryobject
pluginsarrayList of plugins to use with the connector.
service_execution_role_arnstringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
worker_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +
+kafkaconnect:DescribeConnector
+ +### Delete +
+kafkaconnect:DeleteConnector,
+kafkaconnect:DescribeConnector,
+logs:DeleteLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries
+ +### Update +
+kafkaconnect:UpdateConnector,
+kafkaconnect:DescribeConnector,
+iam:CreateServiceLinkedRole,
+logs:UpdateLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+firehose:TagDeliveryStream
+ + +## Example +```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 +FROM awscc.kafkaconnect.connector +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md b/docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md new file mode 100644 index 0000000000..bd106b0730 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md @@ -0,0 +1,74 @@ +--- +title: connectors +hide_title: false +hide_table_of_contents: false +keywords: + - connectors + - 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 +--- +Retrieves a list of connectors in a region + +## Overview + + + + + +
Nameconnectors
TypeResource
Descriptionconnectors
Idawscc.kafkaconnect.connectors
+ +## Fields + + + + + +
NameDatatypeDescription
connector_arnstringAmazon Resource Name for the created Connector.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +
+kafkaconnect:CreateConnector,
+kafkaconnect:DescribeConnector,
+iam:CreateServiceLinkedRole,
+iam:PassRole,
+ec2:CreateNetworkInterface,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+firehose:TagDeliveryStream
+ +### List +
+kafkaconnect:ListConnectors
+ + +## Example +```sql +SELECT +region, +connector_arn +FROM awscc.kafkaconnect.connectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kafkaconnect/index.md b/docs/awscc-docs/providers/awscc/kafkaconnect/index.md new file mode 100644 index 0000000000..ba85c668f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kafkaconnect/index.md @@ -0,0 +1,39 @@ +--- +title: kafkaconnect +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The kafkaconnect service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+connector +
+
+connectors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kendra/data_source/index.md b/docs/awscc-docs/providers/awscc/kendra/data_source/index.md new file mode 100644 index 0000000000..d303703191 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendra/data_source/index.md @@ -0,0 +1,93 @@ +--- +title: data_source +hide_title: false +hide_table_of_contents: false +keywords: + - data_source + - 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 +--- +Gets an individual data_source resource + +## Overview + + + + + +
Namedata_source
TypeResource
Descriptiondata_source
Idawscc.kendra.data_source
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestring
index_idstring
typestring
data_source_configurationobject
descriptionstring
schedulestring
role_arnstring
tagsarrayTags for labeling the data source
custom_document_enrichment_configurationobject
language_codestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_source resource, the following permissions are required: + +### Read +
+kendra:DescribeDataSource,
+kendra:ListTagsForResource
+ +### Delete +
+kendra:DescribeDataSource,
+kendra:DeleteDataSource
+ +### Update +
+kendra:DescribeDataSource,
+kendra:UpdateDataSource,
+kendra:ListTagsForResource,
+kendra:TagResource,
+kendra:UntagResource,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +id, +arn, +name, +index_id, +type, +data_source_configuration, +description, +schedule, +role_arn, +tags, +custom_document_enrichment_configuration, +language_code +FROM awscc.kendra.data_source +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +AND data__Identifier = '<IndexId>' +``` diff --git a/docs/awscc-docs/providers/awscc/kendra/data_sources/index.md b/docs/awscc-docs/providers/awscc/kendra/data_sources/index.md new file mode 100644 index 0000000000..49e85df088 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendra/data_sources/index.md @@ -0,0 +1,64 @@ +--- +title: data_sources +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources + - 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 +--- +Retrieves a list of data_sources in a region + +## Overview + + + + + +
Namedata_sources
TypeResource
Descriptiondata_sources
Idawscc.kendra.data_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
idundefined
index_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +
+kendra:CreateDataSource,
+kendra:DescribeDataSource,
+kendra:ListTagsForResource,
+iam:PassRole,
+kendra:TagResource
+ +### List +
+kendra:ListDataSources
+ + +## Example +```sql +SELECT +region, +id, +index_id +FROM awscc.kendra.data_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kendra/faq/index.md b/docs/awscc-docs/providers/awscc/kendra/faq/index.md new file mode 100644 index 0000000000..447257ffa2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendra/faq/index.md @@ -0,0 +1,84 @@ +--- +title: faq +hide_title: false +hide_table_of_contents: false +keywords: + - faq + - 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 +--- +Gets an individual faq resource + +## Overview + + + + + +
Namefaq
TypeResource
Descriptionfaq
Idawscc.kendra.faq
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
index_idstringIndex ID
namestringFAQ name
descriptionstringFAQ description
file_formatstringFAQ file format
s3_pathobjectFAQ S3 path
role_arnstringFAQ role ARN
tagsarrayTags for labeling the FAQ
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the faq resource, the following permissions are required: + +### Update +
+kendra:ListTagsForResource,
+kendra:UntagResource,
+kendra:TagResource
+ +### Read +
+kendra:DescribeFaq,
+kendra:ListTagsForResource
+ +### Delete +
+kendra:DeleteFaq,
+kendra:DescribeFaq
+ + +## Example +```sql +SELECT +region, +id, +index_id, +name, +description, +file_format, +s3_path, +role_arn, +tags, +arn +FROM awscc.kendra.faq +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +AND data__Identifier = '<IndexId>' +``` diff --git a/docs/awscc-docs/providers/awscc/kendra/faqs/index.md b/docs/awscc-docs/providers/awscc/kendra/faqs/index.md new file mode 100644 index 0000000000..b05b4d32c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendra/faqs/index.md @@ -0,0 +1,64 @@ +--- +title: faqs +hide_title: false +hide_table_of_contents: false +keywords: + - faqs + - 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 +--- +Retrieves a list of faqs in a region + +## Overview + + + + + +
Namefaqs
TypeResource
Descriptionfaqs
Idawscc.kendra.faqs
+ +## Fields + + + + + + +
NameDatatypeDescription
idundefined
index_idundefinedIndex ID
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the faqs resource, the following permissions are required: + +### Create +
+kendra:CreateFaq,
+kendra:DescribeFaq,
+iam:PassRole,
+kendra:ListTagsForResource,
+kendra:TagResource
+ +### List +
+kendra:ListFaqs
+ + +## Example +```sql +SELECT +region, +id, +index_id +FROM awscc.kendra.faqs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kendra/index.md b/docs/awscc-docs/providers/awscc/kendra/index.md new file mode 100644 index 0000000000..11690037a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendra/index.md @@ -0,0 +1,43 @@ +--- +title: kendra +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The kendra service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+data_source
+data_sources
+faq +
+
+faqs
+index
+indices +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kendra/index/index.md b/docs/awscc-docs/providers/awscc/kendra/index/index.md new file mode 100644 index 0000000000..2020bb52a2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendra/index/index.md @@ -0,0 +1,92 @@ +--- +title: index +hide_title: false +hide_table_of_contents: false +keywords: + - index + - 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 +--- +Gets an individual index resource + +## Overview + + + + + +
Nameindex
TypeResource
Descriptionindex
Idawscc.kendra.index
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
descriptionstringA description for the index
server_side_encryption_configurationobjectServer side encryption configuration
tagsarrayTags for labeling the index
namestring
role_arnstring
editionstring
document_metadata_configurationsarrayDocument metadata configurations
capacity_unitsobjectCapacity units
user_context_policystring
user_token_configurationsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the index resource, the following permissions are required: + +### Read +
+kendra:DescribeIndex,
+kendra:ListTagsForResource
+ +### Update +
+kendra:DescribeIndex,
+kendra:UpdateIndex,
+kendra:ListTagsForResource,
+kendra:TagResource,
+kendra:UntagResource,
+iam:PassRole
+ +### Delete +
+kendra:DescribeIndex,
+kendra:DeleteIndex
+ + +## Example +```sql +SELECT +region, +id, +arn, +description, +server_side_encryption_configuration, +tags, +name, +role_arn, +edition, +document_metadata_configurations, +capacity_units, +user_context_policy, +user_token_configurations +FROM awscc.kendra.index +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/kendra/indices/index.md b/docs/awscc-docs/providers/awscc/kendra/indices/index.md new file mode 100644 index 0000000000..b6ede05f49 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendra/indices/index.md @@ -0,0 +1,63 @@ +--- +title: indices +hide_title: false +hide_table_of_contents: false +keywords: + - indices + - 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 +--- +Retrieves a list of indices in a region + +## Overview + + + + + +
Nameindices
TypeResource
Descriptionindices
Idawscc.kendra.indices
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the indices resource, the following permissions are required: + +### Create +
+kendra:CreateIndex,
+kendra:DescribeIndex,
+kendra:UpdateIndex,
+kendra:ListTagsForResource,
+iam:PassRole,
+kendra:TagResource
+ +### List +
+kendra:ListIndices
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.kendra.indices +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md b/docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md new file mode 100644 index 0000000000..cf9087ffa1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md @@ -0,0 +1,79 @@ +--- +title: execution_plan +hide_title: false +hide_table_of_contents: false +keywords: + - execution_plan + - 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 +--- +Gets an individual execution_plan resource + +## Overview + + + + + +
Nameexecution_plan
TypeResource
Descriptionexecution_plan
Idawscc.kendraranking.execution_plan
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
descriptionstringA description for the execution plan
tagsarrayTags for labeling the execution plan
namestring
capacity_unitsobjectCapacity units
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the execution_plan resource, the following permissions are required: + +### Read +
+kendra-ranking:DescribeRescoreExecutionPlan,
+kendra-ranking:ListTagsForResource
+ +### Update +
+kendra-ranking:DescribeRescoreExecutionPlan,
+kendra-ranking:UpdateRescoreExecutionPlan,
+kendra-ranking:ListTagsForResource,
+kendra-ranking:TagResource,
+kendra-ranking:UntagResource
+ +### Delete +
+kendra-ranking:DescribeRescoreExecutionPlan,
+kendra-ranking:DeleteRescoreExecutionPlan
+ + +## Example +```sql +SELECT +region, +id, +arn, +description, +tags, +name, +capacity_units +FROM awscc.kendraranking.execution_plan +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md b/docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md new file mode 100644 index 0000000000..4635f01b54 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md @@ -0,0 +1,62 @@ +--- +title: execution_plans +hide_title: false +hide_table_of_contents: false +keywords: + - execution_plans + - 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 +--- +Retrieves a list of execution_plans in a region + +## Overview + + + + + +
Nameexecution_plans
TypeResource
Descriptionexecution_plans
Idawscc.kendraranking.execution_plans
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the execution_plans resource, the following permissions are required: + +### Create +
+kendra-ranking:CreateRescoreExecutionPlan,
+kendra-ranking:DescribeRescoreExecutionPlan,
+kendra-ranking:UpdateRescoreExecutionPlan,
+kendra-ranking:ListTagsForResource,
+kendra-ranking:TagResource
+ +### List +
+kendra-ranking:ListRescoreExecutionPlans
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.kendraranking.execution_plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kendraranking/index.md b/docs/awscc-docs/providers/awscc/kendraranking/index.md new file mode 100644 index 0000000000..3ab3b79c62 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kendraranking/index.md @@ -0,0 +1,39 @@ +--- +title: kendraranking +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The kendraranking service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+execution_plan +
+
+execution_plans +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kinesis/index.md b/docs/awscc-docs/providers/awscc/kinesis/index.md new file mode 100644 index 0000000000..35d1b76523 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesis/index.md @@ -0,0 +1,39 @@ +--- +title: kinesis +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The kinesis service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+kinesis_stream +
+
+streams +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kinesis/kinesis_stream/index.md b/docs/awscc-docs/providers/awscc/kinesis/kinesis_stream/index.md new file mode 100644 index 0000000000..377184b624 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesis/kinesis_stream/index.md @@ -0,0 +1,89 @@ +--- +title: kinesis_stream +hide_title: false +hide_table_of_contents: false +keywords: + - kinesis_stream + - 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 +--- +Gets an individual kinesis_stream resource + +## Overview + + + + + +
Namekinesis_stream
TypeResource
Descriptionkinesis_stream
Idawscc.kinesis.kinesis_stream
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stream_mode_detailsobjectThe mode in which the stream is running.
stream_encryptionobjectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
arnstringThe Amazon resource name (ARN) of the Kinesis stream
retention_period_hoursintegerThe number of hours for the data records that are stored in shards to remain accessible.
tagsarrayAn arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
namestringThe name of the Kinesis stream.
shard_countintegerThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the kinesis_stream resource, the following permissions are required: + +### Read +
+kinesis:DescribeStreamSummary,
+kinesis:ListTagsForStream
+ +### Update +
+kinesis:EnableEnhancedMonitoring,
+kinesis:DisableEnhancedMonitoring,
+kinesis:DescribeStreamSummary,
+kinesis:UpdateShardCount,
+kinesis:UpdateStreamMode,
+kinesis:IncreaseStreamRetentionPeriod,
+kinesis:DecreaseStreamRetentionPeriod,
+kinesis:StartStreamEncryption,
+kinesis:StopStreamEncryption,
+kinesis:AddTagsToStream,
+kinesis:RemoveTagsFromStream,
+kinesis:ListTagsForStream
+ +### Delete +
+kinesis:DescribeStreamSummary,
+kinesis:DeleteStream,
+kinesis:RemoveTagsFromStream
+ + +## Example +```sql +SELECT +region, +stream_mode_details, +stream_encryption, +arn, +retention_period_hours, +tags, +name, +shard_count +FROM awscc.kinesis.kinesis_stream +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesis/streams/index.md b/docs/awscc-docs/providers/awscc/kinesis/streams/index.md new file mode 100644 index 0000000000..ffb66984f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesis/streams/index.md @@ -0,0 +1,64 @@ +--- +title: streams +hide_title: false +hide_table_of_contents: false +keywords: + - streams + - 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 +--- +Retrieves a list of streams in a region + +## Overview + + + + + +
Namestreams
TypeResource
Descriptionstreams
Idawscc.kinesis.streams
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the Kinesis stream.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +
+kinesis:EnableEnhancedMonitoring,
+kinesis:DescribeStreamSummary,
+kinesis:CreateStream,
+kinesis:IncreaseStreamRetentionPeriod,
+kinesis:StartStreamEncryption,
+kinesis:AddTagsToStream,
+kinesis:ListTagsForStream
+ +### List +
+kinesis:ListStreams
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.kinesis.streams +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md new file mode 100644 index 0000000000..33d26ebac4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md @@ -0,0 +1,88 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.kinesisanalyticsv2.application
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
application_configurationobjectUse this parameter to configure the application.
application_descriptionstringThe description of the application.
application_modestringTo 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.
application_namestringThe name of the application.
runtime_environmentstringThe runtime environment for the application.
service_execution_rolestringSpecifies the IAM role that the application uses to access external resources.
run_configurationobjectSpecifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only.
application_maintenance_configurationobjectUsed to configure start of maintenance window.
tagsarrayA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+kinesisanalytics:DescribeApplication,
+kinesisanalytics:ListTagsForResource
+ +### Update +
+kinesisanalytics:UpdateApplication,
+kinesisanalytics:DescribeApplication,
+kinesisanalytics:TagResource,
+kinesisanalytics:UntagResource,
+kinesisanalytics:AddApplicationVpcConfiguration,
+kinesisanalytics:DeleteApplicationVpcConfiguration,
+kinesisanalytics:UpdateApplicationMaintenanceConfiguration,
+kinesisanalytics:ListTagsForResource
+ +### Delete +
+kinesisanalytics:DescribeApplication,
+kinesisanalytics:DeleteApplication
+ + +## Example +```sql +SELECT +region, +application_configuration, +application_description, +application_mode, +application_name, +runtime_environment, +service_execution_role, +run_configuration, +application_maintenance_configuration, +tags +FROM awscc.kinesisanalyticsv2.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md new file mode 100644 index 0000000000..ad3add8776 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md @@ -0,0 +1,62 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.kinesisanalyticsv2.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_namestringThe name of the application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+iam:PassRole,
+kinesisanalytics:CreateApplication,
+kinesisanalytics:DescribeApplication,
+kinesisanalytics:ListTagsForResource,
+kinesisanalytics:UpdateApplicationMaintenanceConfiguration
+ +### List +
+kinesisanalytics:ListApplications
+ + +## Example +```sql +SELECT +region, +application_name +FROM awscc.kinesisanalyticsv2.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md new file mode 100644 index 0000000000..4cd768cdfa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md @@ -0,0 +1,39 @@ +--- +title: kinesisanalyticsv2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The kinesisanalyticsv2 service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+application +
+
+applications +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_stream/index.md b/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_stream/index.md new file mode 100644 index 0000000000..8174ce4eaf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_stream/index.md @@ -0,0 +1,106 @@ +--- +title: delivery_stream +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_stream + - 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 +--- +Gets an individual delivery_stream resource + +## Overview + + + + + +
Namedelivery_stream
TypeResource
Descriptiondelivery_stream
Idawscc.kinesisfirehose.delivery_stream
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
delivery_stream_encryption_configuration_inputobject
delivery_stream_namestring
delivery_stream_typestring
elasticsearch_destination_configurationobject
amazonopensearchservice_destination_configurationobject
amazon_open_search_serverless_destination_configurationobject
extended_s3_destination_configurationobject
kinesis_stream_source_configurationobject
m_sk_source_configurationobject
redshift_destination_configurationobject
s3_destination_configurationobject
splunk_destination_configurationobject
http_endpoint_destination_configurationobject
snowflake_destination_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the delivery_stream resource, the following permissions are required: + +### Read +
+firehose:DescribeDeliveryStream,
+firehose:ListTagsForDeliveryStream
+ +### Update +
+firehose:UpdateDestination,
+firehose:DescribeDeliveryStream,
+firehose:StartDeliveryStreamEncryption,
+firehose:StopDeliveryStreamEncryption,
+firehose:ListTagsForDeliveryStream,
+firehose:TagDeliveryStream,
+firehose:UntagDeliveryStream,
+kms:CreateGrant,
+kms:RevokeGrant,
+kms:DescribeKey
+ +### Delete +
+firehose:DeleteDeliveryStream,
+firehose:DescribeDeliveryStream,
+kms:RevokeGrant,
+kms:DescribeKey
+ + +## Example +```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, +m_sk_source_configuration, +redshift_destination_configuration, +s3_destination_configuration, +splunk_destination_configuration, +http_endpoint_destination_configuration, +snowflake_destination_configuration, +tags +FROM awscc.kinesisfirehose.delivery_stream +WHERE region = 'us-east-1' +AND data__Identifier = '<DeliveryStreamName>' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md b/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md new file mode 100644 index 0000000000..d5aaf5a4c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md @@ -0,0 +1,63 @@ +--- +title: delivery_streams +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_streams + - 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 +--- +Retrieves a list of delivery_streams in a region + +## Overview + + + + + +
Namedelivery_streams
TypeResource
Descriptiondelivery_streams
Idawscc.kinesisfirehose.delivery_streams
+ +## Fields + + + + + +
NameDatatypeDescription
delivery_stream_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the delivery_streams resource, the following permissions are required: + +### Create +
+firehose:CreateDeliveryStream,
+firehose:DescribeDeliveryStream,
+iam:GetRole,
+iam:PassRole,
+kms:CreateGrant,
+kms:DescribeKey
+ +### List +
+firehose:ListDeliveryStreams
+ + +## Example +```sql +SELECT +region, +delivery_stream_name +FROM awscc.kinesisfirehose.delivery_streams +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisfirehose/index.md b/docs/awscc-docs/providers/awscc/kinesisfirehose/index.md new file mode 100644 index 0000000000..1dd82f724d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisfirehose/index.md @@ -0,0 +1,39 @@ +--- +title: kinesisfirehose +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The kinesisfirehose service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+delivery_stream +
+
+delivery_streams +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kinesisvideo/index.md b/docs/awscc-docs/providers/awscc/kinesisvideo/index.md new file mode 100644 index 0000000000..0ba3a290b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisvideo/index.md @@ -0,0 +1,41 @@ +--- +title: kinesisvideo +hide_title: false +hide_table_of_contents: false +keywords: + - kinesisvideo + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The kinesisvideo service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+kinesisvideo_stream
+signaling_channel +
+
+signaling_channels
+streams +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kinesisvideo/kinesisvideo_stream/index.md b/docs/awscc-docs/providers/awscc/kinesisvideo/kinesisvideo_stream/index.md new file mode 100644 index 0000000000..d6f9b2fcba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisvideo/kinesisvideo_stream/index.md @@ -0,0 +1,78 @@ +--- +title: kinesisvideo_stream +hide_title: false +hide_table_of_contents: false +keywords: + - kinesisvideo_stream + - kinesisvideo + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual kinesisvideo_stream resource + +## Overview + + + + + +
Namekinesisvideo_stream
TypeResource
Descriptionkinesisvideo_stream
Idawscc.kinesisvideo.kinesisvideo_stream
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the Kinesis Video stream.
namestringThe name of the Kinesis Video stream.
data_retention_in_hoursintegerThe number of hours till which Kinesis Video will retain the data in the stream
device_namestringThe name of the device that is writing to the stream.
kms_key_idstringAWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
media_typestringThe media type of the stream. Consumers of the stream can use this information when processing the stream.
tagsarrayAn array of key-value pairs associated with the Kinesis Video Stream.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the kinesisvideo_stream resource, the following permissions are required: + +### Read +
+kinesisvideo:DescribeStream
+ +### Update +
+kinesisvideo:DescribeStream,
+kinesisvideo:UpdateStream,
+kinesisvideo:UpdateDataRetention
+ +### Delete +
+kinesisvideo:DescribeStream,
+kinesisvideo:DeleteStream
+ + +## Example +```sql +SELECT +region, +arn, +name, +data_retention_in_hours, +device_name, +kms_key_id, +media_type, +tags +FROM awscc.kinesisvideo.kinesisvideo_stream +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md b/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md new file mode 100644 index 0000000000..f0c79c0c29 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md @@ -0,0 +1,73 @@ +--- +title: signaling_channel +hide_title: false +hide_table_of_contents: false +keywords: + - signaling_channel + - kinesisvideo + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual signaling_channel resource + +## Overview + + + + + +
Namesignaling_channel
TypeResource
Descriptionsignaling_channel
Idawscc.kinesisvideo.signaling_channel
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
namestringThe name of the Kinesis Video Signaling Channel.
typestringThe type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
message_ttl_secondsintegerThe period of time a signaling channel retains undelivered messages before they are discarded.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the signaling_channel resource, the following permissions are required: + +### Read +
+kinesisvideo:DescribeSignalingChannel
+ +### Update +
+kinesisvideo:UpdateSignalingChannel,
+kinesisvideo:DescribeSignalingChannel
+ +### Delete +
+kinesisvideo:DeleteSignalingChannel,
+kinesisvideo:DescribeSignalingChannel
+ + +## Example +```sql +SELECT +region, +arn, +name, +type, +message_ttl_seconds, +tags +FROM awscc.kinesisvideo.signaling_channel +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channels/index.md b/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channels/index.md new file mode 100644 index 0000000000..1514f4a708 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channels/index.md @@ -0,0 +1,55 @@ +--- +title: signaling_channels +hide_title: false +hide_table_of_contents: false +keywords: + - signaling_channels + - kinesisvideo + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of signaling_channels in a region + +## Overview + + + + + +
Namesignaling_channels
TypeResource
Descriptionsignaling_channels
Idawscc.kinesisvideo.signaling_channels
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the Kinesis Video Signaling Channel.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the signaling_channels resource, the following permissions are required: + +### Create +
+kinesisvideo:CreateSignalingChannel,
+kinesisvideo:DescribeSignalingChannel
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.kinesisvideo.signaling_channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kinesisvideo/streams/index.md b/docs/awscc-docs/providers/awscc/kinesisvideo/streams/index.md new file mode 100644 index 0000000000..06d71f0e23 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kinesisvideo/streams/index.md @@ -0,0 +1,55 @@ +--- +title: streams +hide_title: false +hide_table_of_contents: false +keywords: + - streams + - kinesisvideo + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of streams in a region + +## Overview + + + + + +
Namestreams
TypeResource
Descriptionstreams
Idawscc.kinesisvideo.streams
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the Kinesis Video stream.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +
+kinesisvideo:DescribeStream,
+kinesisvideo:CreateStream
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.kinesisvideo.streams +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kms/alias/index.md b/docs/awscc-docs/providers/awscc/kms/alias/index.md new file mode 100644 index 0000000000..613127f036 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kms/alias/index.md @@ -0,0 +1,65 @@ +--- +title: alias +hide_title: false +hide_table_of_contents: false +keywords: + - alias + - 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 +--- +Gets an individual alias resource + +## Overview + + + + + +
Namealias
TypeResource
Descriptionalias
Idawscc.kms.alias
+ +## Fields + + + + + + +
NameDatatypeDescription
target_key_idstringAssociates 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.<br/> A valid key ID is required. If you supply a null or empty string value, this operation returns an error.<br/> 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*.<br/> Specify the key ID or the key ARN of the KMS key.<br/> For example:<br/> + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` <br/> + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` <br/> <br/> 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).
alias_namestringSpecifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. <br/> 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).<br/> 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).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alias resource, the following permissions are required: + +### Read +
+kms:ListAliases
+ +### Update +
+kms:UpdateAlias
+ +### Delete +
+kms:DeleteAlias
+ + +## Example +```sql +SELECT +region, +target_key_id, +alias_name +FROM awscc.kms.alias +WHERE region = 'us-east-1' +AND data__Identifier = '<AliasName>' +``` diff --git a/docs/awscc-docs/providers/awscc/kms/aliases/index.md b/docs/awscc-docs/providers/awscc/kms/aliases/index.md new file mode 100644 index 0000000000..ae5224bd45 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kms/aliases/index.md @@ -0,0 +1,58 @@ +--- +title: aliases +hide_title: false +hide_table_of_contents: false +keywords: + - aliases + - 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 +--- +Retrieves a list of aliases in a region + +## Overview + + + + + +
Namealiases
TypeResource
Descriptionaliases
Idawscc.kms.aliases
+ +## Fields + + + + + +
NameDatatypeDescription
alias_namestringSpecifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. <br/> 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).<br/> 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).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Create +
+kms:CreateAlias
+ +### List +
+kms:ListAliases
+ + +## Example +```sql +SELECT +region, +alias_name +FROM awscc.kms.aliases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kms/index.md b/docs/awscc-docs/providers/awscc/kms/index.md new file mode 100644 index 0000000000..d89bcb8668 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kms/index.md @@ -0,0 +1,43 @@ +--- +title: kms +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The kms service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+alias
+aliases
+key +
+
+keys
+replica_key
+replica_keys +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/kms/key/index.md b/docs/awscc-docs/providers/awscc/kms/key/index.md new file mode 100644 index 0000000000..96434a55a2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kms/key/index.md @@ -0,0 +1,100 @@ +--- +title: key +hide_title: false +hide_table_of_contents: false +keywords: + - key + - 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 +--- +Gets an individual key resource + +## Overview + + + + + +
Namekey
TypeResource
Descriptionkey
Idawscc.kms.key
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA 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.
enabledbooleanSpecifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.<br/> 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``.<br/> 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.<br/> 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*.
enable_key_rotationbooleanEnables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.<br/> 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``.<br/> 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*.<br/> 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. Fo
key_policyobjectThe key policy to attach to the KMS key.<br/> If you provide a key policy, it must meet the following criteria:<br/> + 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.)<br/> + 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 [
key_usagestringDetermines 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.<br/> 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.<br/> Select only one valid value.<br/> + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``.<br/> + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.<br/> + For asymmetric KMS keys with ECC key material, specify
originstringThe 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.<br/> 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*.<br/> 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. <br/> CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.
key_specstringSpecifies 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*.<br/> 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*.<br/> If you change the value of the ``KeySpec`` property on an existing KMS key, the u
multi_regionbooleanCreates 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.<br/> 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 **.<br/> 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.<br/> 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``.<br/> *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Bec
pending_window_in_daysintegerSpecifies 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.<br/> 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.<br/> 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 ope
tagsarrayAssigns one or more tags to the replica key.<br/> 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*.<br/> 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).
arnstring
key_idstring
bypass_policy_lockout_safety_checkbooleanSkips ("bypasses") the key policy lockout safety check. The default value is false.<br/> Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.<br/> 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*.<br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the key resource, the following permissions are required: + +### Read +
+kms:DescribeKey,
+kms:GetKeyPolicy,
+kms:GetKeyRotationStatus,
+kms:ListResourceTags
+ +### Update +
+kms:DescribeKey,
+kms:DisableKey,
+kms:DisableKeyRotation,
+kms:EnableKey,
+kms:EnableKeyRotation,
+kms:PutKeyPolicy,
+kms:TagResource,
+kms:UntagResource,
+kms:UpdateKeyDescription,
+kms:ListResourceTags
+ +### Delete +
+kms:DescribeKey,
+kms:ScheduleKeyDeletion
+ + +## Example +```sql +SELECT +region, +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 +FROM awscc.kms.key +WHERE region = 'us-east-1' +AND data__Identifier = '<KeyId>' +``` diff --git a/docs/awscc-docs/providers/awscc/kms/keys/index.md b/docs/awscc-docs/providers/awscc/kms/keys/index.md new file mode 100644 index 0000000000..6473670ca5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kms/keys/index.md @@ -0,0 +1,63 @@ +--- +title: keys +hide_title: false +hide_table_of_contents: false +keywords: + - keys + - 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 +--- +Retrieves a list of keys in a region + +## Overview + + + + + +
Namekeys
TypeResource
Descriptionkeys
Idawscc.kms.keys
+ +## Fields + + + + + +
NameDatatypeDescription
key_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the keys resource, the following permissions are required: + +### Create +
+kms:CreateKey,
+kms:EnableKeyRotation,
+kms:DisableKey,
+kms:TagResource,
+kms:PutKeyPolicy
+ +### List +
+kms:ListKeys,
+kms:DescribeKey
+ + +## Example +```sql +SELECT +region, +key_id +FROM awscc.kms.keys +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/kms/replica_key/index.md b/docs/awscc-docs/providers/awscc/kms/replica_key/index.md new file mode 100644 index 0000000000..ab0e4ffda1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kms/replica_key/index.md @@ -0,0 +1,86 @@ +--- +title: replica_key +hide_title: false +hide_table_of_contents: false +keywords: + - replica_key + - 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 +--- +Gets an individual replica_key resource + +## Overview + + + + + +
Namereplica_key
TypeResource
Descriptionreplica_key
Idawscc.kms.replica_key
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA 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.
pending_window_in_daysintegerSpecifies 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.
key_policyobjectThe key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
primary_key_arnstringIdentifies 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.
enabledbooleanSpecifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
key_idstring
arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replica_key resource, the following permissions are required: + +### Read +
+kms:DescribeKey,
+kms:GetKeyPolicy,
+kms:ListResourceTags
+ +### Update +
+kms:DescribeKey,
+kms:DisableKey,
+kms:EnableKey,
+kms:PutKeyPolicy,
+kms:TagResource,
+kms:UntagResource,
+kms:UpdateKeyDescription
+ +### Delete +
+kms:DescribeKey,
+kms:ScheduleKeyDeletion
+ + +## Example +```sql +SELECT +region, +description, +pending_window_in_days, +key_policy, +primary_key_arn, +enabled, +key_id, +arn, +tags +FROM awscc.kms.replica_key +WHERE region = 'us-east-1' +AND data__Identifier = '<KeyId>' +``` diff --git a/docs/awscc-docs/providers/awscc/kms/replica_keys/index.md b/docs/awscc-docs/providers/awscc/kms/replica_keys/index.md new file mode 100644 index 0000000000..44dd5fb950 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/kms/replica_keys/index.md @@ -0,0 +1,63 @@ +--- +title: replica_keys +hide_title: false +hide_table_of_contents: false +keywords: + - replica_keys + - 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 +--- +Retrieves a list of replica_keys in a region + +## Overview + + + + + +
Namereplica_keys
TypeResource
Descriptionreplica_keys
Idawscc.kms.replica_keys
+ +## Fields + + + + + +
NameDatatypeDescription
key_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replica_keys resource, the following permissions are required: + +### Create +
+kms:ReplicateKey,
+kms:CreateKey,
+kms:DescribeKey,
+kms:DisableKey,
+kms:TagResource
+ +### List +
+kms:ListKeys,
+kms:DescribeKey
+ + +## Example +```sql +SELECT +region, +key_id +FROM awscc.kms.replica_keys +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filter/index.md b/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filter/index.md new file mode 100644 index 0000000000..34c7524dad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filter/index.md @@ -0,0 +1,74 @@ +--- +title: data_cells_filter +hide_title: false +hide_table_of_contents: false +keywords: + - data_cells_filter + - 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 +--- +Gets an individual data_cells_filter resource + +## Overview + + + + + +
Namedata_cells_filter
TypeResource
Descriptiondata_cells_filter
Idawscc.lakeformation.data_cells_filter
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
table_catalog_idstringThe Catalog Id of the Table on which to create a Data Cells Filter.
database_namestringThe name of the Database that the Table resides in.
table_namestringThe name of the Table to create a Data Cells Filter for.
namestringThe desired name of the Data Cells Filter.
row_filterobjectAn object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
column_namesarrayA list of columns to be included in this Data Cells Filter.
column_wildcardobjectAn object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_cells_filter resource, the following permissions are required: + +### Delete +
+lakeformation:DeleteDataCellsFilter
+ +### Read +
+lakeformation:ListDataCellsFilter
+ + +## Example +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name, +row_filter, +column_names, +column_wildcard +FROM awscc.lakeformation.data_cells_filter +WHERE region = 'us-east-1' +AND data__Identifier = '<TableCatalogId>' +AND data__Identifier = '<DatabaseName>' +AND data__Identifier = '<TableName>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filters/index.md b/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filters/index.md new file mode 100644 index 0000000000..decb0a80fe --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filters/index.md @@ -0,0 +1,65 @@ +--- +title: data_cells_filters +hide_title: false +hide_table_of_contents: false +keywords: + - data_cells_filters + - 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 +--- +Retrieves a list of data_cells_filters in a region + +## Overview + + + + + +
Namedata_cells_filters
TypeResource
Descriptiondata_cells_filters
Idawscc.lakeformation.data_cells_filters
+ +## Fields + + + + + + + + +
NameDatatypeDescription
table_catalog_idundefinedThe Catalog Id of the Table on which to create a Data Cells Filter.
database_nameundefinedThe name of the Database that the Table resides in.
table_nameundefinedThe name of the Table to create a Data Cells Filter for.
nameundefinedThe desired name of the Data Cells Filter.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_cells_filters resource, the following permissions are required: + +### Create +
+lakeformation:CreateDataCellsFilter,
+glue:GetTable
+ +### List +
+lakeformation:ListDataCellsFilter
+ + +## Example +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name +FROM awscc.lakeformation.data_cells_filters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lakeformation/index.md b/docs/awscc-docs/providers/awscc/lakeformation/index.md new file mode 100644 index 0000000000..3a5333e5a4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/index.md @@ -0,0 +1,44 @@ +--- +title: lakeformation +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The lakeformation service documentation. + +:::info Service Summary + +
+
+total resources: 7
+total selectable resources: 7
+total methods: 7
+
+
+ +::: + +## Resources +
+
+data_cells_filter
+data_cells_filters
+principal_permissions
+tag +
+
+tag_association
+tag_associations
+tags +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/lakeformation/principal_permissions/index.md b/docs/awscc-docs/providers/awscc/lakeformation/principal_permissions/index.md new file mode 100644 index 0000000000..daaa7d76c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/principal_permissions/index.md @@ -0,0 +1,77 @@ +--- +title: principal_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - principal_permissions + - 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 +--- +Gets an individual principal_permissions resource + +## Overview + + + + + +
Nameprincipal_permissions
TypeResource
Descriptionprincipal_permissions
Idawscc.lakeformation.principal_permissions
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
catalogstring
principalobject
resourceobject
permissionsarray
permissions_with_grant_optionarray
principal_identifierstring
resource_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the principal_permissions resource, the following permissions are required: + +### Read +
+lakeformation:ListPermissions,
+glue:GetTable,
+glue:GetDatabase
+ +### Delete +
+lakeformation:RevokePermissions,
+lakeformation:ListPermissions,
+glue:GetTable,
+glue:GetDatabase
+ + +## Example +```sql +SELECT +region, +catalog, +principal, +resource, +permissions, +permissions_with_grant_option, +principal_identifier, +resource_identifier +FROM awscc.lakeformation.principal_permissions +WHERE region = 'us-east-1' +AND data__Identifier = '<PrincipalIdentifier>' +AND data__Identifier = '<ResourceIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/lakeformation/tag/index.md b/docs/awscc-docs/providers/awscc/lakeformation/tag/index.md new file mode 100644 index 0000000000..162b630ea7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/tag/index.md @@ -0,0 +1,67 @@ +--- +title: tag +hide_title: false +hide_table_of_contents: false +keywords: + - tag + - 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 +--- +Gets an individual tag resource + +## Overview + + + + + +
Nametag
TypeResource
Descriptiontag
Idawscc.lakeformation.tag
+ +## Fields + + + + + + + +
NameDatatypeDescription
catalog_idstringThe 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.
tag_keystringThe key-name for the LF-tag.
tag_valuesarrayA list of possible values an attribute can take.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tag resource, the following permissions are required: + +### Read +
+lakeformation:GetLFTag
+ +### Update +
+lakeformation:UpdateLFTag
+ +### Delete +
+lakeformation:DeleteLFTag
+ + +## Example +```sql +SELECT +region, +catalog_id, +tag_key, +tag_values +FROM awscc.lakeformation.tag +WHERE region = 'us-east-1' +AND data__Identifier = '<TagKey>' +``` diff --git a/docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md b/docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md new file mode 100644 index 0000000000..a41efd450e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md @@ -0,0 +1,70 @@ +--- +title: tag_association +hide_title: false +hide_table_of_contents: false +keywords: + - tag_association + - 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 +--- +Gets an individual tag_association resource + +## Overview + + + + + +
Nametag_association
TypeResource
Descriptiontag_association
Idawscc.lakeformation.tag_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
resourceobjectResource to tag with the Lake Formation Tags
l_ftagsarrayList of Lake Formation Tags to associate with the Lake Formation Resource
resource_identifierstringUnique string identifying the resource. Used as primary identifier, which ideally should be a string
tags_identifierstringUnique string identifying the resource's tags. Used as primary identifier, which ideally should be a string
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tag_association resource, the following permissions are required: + +### Read +
+lakeformation:GetResourceLFTags,
+glue:GetDatabase,
+glue:GetTable
+ +### Delete +
+lakeformation:RemoveLFTagsFromResource,
+glue:GetDatabase,
+glue:GetTable
+ + +## Example +```sql +SELECT +region, +resource, +l_ftags, +resource_identifier, +tags_identifier +FROM awscc.lakeformation.tag_association +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceIdentifier>' +AND data__Identifier = '<TagsIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/lakeformation/tag_associations/index.md b/docs/awscc-docs/providers/awscc/lakeformation/tag_associations/index.md new file mode 100644 index 0000000000..5e9d165fa7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/tag_associations/index.md @@ -0,0 +1,58 @@ +--- +title: tag_associations +hide_title: false +hide_table_of_contents: false +keywords: + - tag_associations + - 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 +--- +Retrieves a list of tag_associations in a region + +## Overview + + + + + +
Nametag_associations
TypeResource
Descriptiontag_associations
Idawscc.lakeformation.tag_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_identifierstringUnique string identifying the resource. Used as primary identifier, which ideally should be a string
tags_identifierstringUnique string identifying the resource's tags. Used as primary identifier, which ideally should be a string
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tag_associations resource, the following permissions are required: + +### Create +
+lakeformation:AddLFTagsToResource,
+glue:GetDatabase,
+glue:GetTable
+ + +## Example +```sql +SELECT +region, +resource_identifier, +tags_identifier +FROM awscc.lakeformation.tag_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lakeformation/tags/index.md b/docs/awscc-docs/providers/awscc/lakeformation/tags/index.md new file mode 100644 index 0000000000..793b6dbb72 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lakeformation/tags/index.md @@ -0,0 +1,58 @@ +--- +title: tags +hide_title: false +hide_table_of_contents: false +keywords: + - tags + - 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 +--- +Retrieves a list of tags in a region + +## Overview + + + + + +
Nametags
TypeResource
Descriptiontags
Idawscc.lakeformation.tags
+ +## Fields + + + + + +
NameDatatypeDescription
tag_keyundefinedThe key-name for the LF-tag.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tags resource, the following permissions are required: + +### Create +
+lakeformation:CreateLFTag
+ +### List +
+lakeformation:ListLFTags
+ + +## Example +```sql +SELECT +region, +tag_key +FROM awscc.lakeformation.tags +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/code_signing_config/index.md b/docs/awscc-docs/providers/awscc/lambda/code_signing_config/index.md new file mode 100644 index 0000000000..9565d25777 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/code_signing_config/index.md @@ -0,0 +1,71 @@ +--- +title: code_signing_config +hide_title: false +hide_table_of_contents: false +keywords: + - code_signing_config + - 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 +--- +Gets an individual code_signing_config resource + +## Overview + + + + + +
Namecode_signing_config
TypeResource
Descriptioncode_signing_config
Idawscc.lambda.code_signing_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstringA description of the CodeSigningConfig
allowed_publishersobjectWhen the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list
code_signing_policiesobjectPolicies to control how to act if a signature is invalid
code_signing_config_idstringA unique identifier for CodeSigningConfig resource
code_signing_config_arnstringA unique Arn for CodeSigningConfig resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the code_signing_config resource, the following permissions are required: + +### Read +
+lambda:GetCodeSigningConfig
+ +### Update +
+lambda:UpdateCodeSigningConfig
+ +### Delete +
+lambda:DeleteCodeSigningConfig
+ + +## Example +```sql +SELECT +region, +description, +allowed_publishers, +code_signing_policies, +code_signing_config_id, +code_signing_config_arn +FROM awscc.lambda.code_signing_config +WHERE region = 'us-east-1' +AND data__Identifier = '<CodeSigningConfigArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/code_signing_configs/index.md b/docs/awscc-docs/providers/awscc/lambda/code_signing_configs/index.md new file mode 100644 index 0000000000..902a0a03c9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/code_signing_configs/index.md @@ -0,0 +1,58 @@ +--- +title: code_signing_configs +hide_title: false +hide_table_of_contents: false +keywords: + - code_signing_configs + - 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 +--- +Retrieves a list of code_signing_configs in a region + +## Overview + + + + + +
Namecode_signing_configs
TypeResource
Descriptioncode_signing_configs
Idawscc.lambda.code_signing_configs
+ +## Fields + + + + + +
NameDatatypeDescription
code_signing_config_arnstringA unique Arn for CodeSigningConfig resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the code_signing_configs resource, the following permissions are required: + +### Create +
+lambda:CreateCodeSigningConfig
+ +### List +
+lambda:ListCodeSigningConfigs
+ + +## Example +```sql +SELECT +region, +code_signing_config_arn +FROM awscc.lambda.code_signing_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/event_invoke_config/index.md b/docs/awscc-docs/providers/awscc/lambda/event_invoke_config/index.md new file mode 100644 index 0000000000..ab6006a3c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/event_invoke_config/index.md @@ -0,0 +1,72 @@ +--- +title: event_invoke_config +hide_title: false +hide_table_of_contents: false +keywords: + - event_invoke_config + - 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 +--- +Gets an individual event_invoke_config resource + +## Overview + + + + + +
Nameevent_invoke_config
TypeResource
Descriptionevent_invoke_config
Idawscc.lambda.event_invoke_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
destination_configobject
function_namestringThe name of the Lambda function.
maximum_event_age_in_secondsintegerThe maximum age of a request that Lambda sends to a function for processing.
maximum_retry_attemptsintegerThe maximum number of times to retry when the function returns an error.
qualifierstringThe identifier of a version or alias.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_invoke_config resource, the following permissions are required: + +### Read +
+lambda:GetFunctionEventInvokeConfig
+ +### Update +
+lambda:UpdateFunctionEventInvokeConfig
+ +### Delete +
+lambda:DeleteFunctionEventInvokeConfig
+ + +## Example +```sql +SELECT +region, +destination_config, +function_name, +maximum_event_age_in_seconds, +maximum_retry_attempts, +qualifier +FROM awscc.lambda.event_invoke_config +WHERE region = 'us-east-1' +AND data__Identifier = '<FunctionName>' +AND data__Identifier = '<Qualifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/event_invoke_configs/index.md b/docs/awscc-docs/providers/awscc/lambda/event_invoke_configs/index.md new file mode 100644 index 0000000000..715f18bb3a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/event_invoke_configs/index.md @@ -0,0 +1,60 @@ +--- +title: event_invoke_configs +hide_title: false +hide_table_of_contents: false +keywords: + - event_invoke_configs + - 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 +--- +Retrieves a list of event_invoke_configs in a region + +## Overview + + + + + +
Nameevent_invoke_configs
TypeResource
Descriptionevent_invoke_configs
Idawscc.lambda.event_invoke_configs
+ +## Fields + + + + + + +
NameDatatypeDescription
function_namestringThe name of the Lambda function.
qualifierstringThe identifier of a version or alias.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_invoke_configs resource, the following permissions are required: + +### Create +
+lambda:PutFunctionEventInvokeConfig
+ +### List +
+lambda:ListFunctionEventInvokeConfigs
+ + +## Example +```sql +SELECT +region, +function_name, +qualifier +FROM awscc.lambda.event_invoke_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/event_source_mapping/index.md b/docs/awscc-docs/providers/awscc/lambda/event_source_mapping/index.md new file mode 100644 index 0000000000..a3f9154d66 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/event_source_mapping/index.md @@ -0,0 +1,111 @@ +--- +title: event_source_mapping +hide_title: false +hide_table_of_contents: false +keywords: + - event_source_mapping + - 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 +--- +Gets an individual event_source_mapping resource + +## Overview + + + + + +
Nameevent_source_mapping
TypeResource
Descriptionevent_source_mapping
Idawscc.lambda.event_source_mapping
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringEvent Source Mapping Identifier UUID.
batch_sizeintegerThe maximum number of items to retrieve in a single batch.
bisect_batch_on_function_errorboolean(Streams) If the function returns an error, split the batch in two and retry.
destination_configobject(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
enabledbooleanDisables the event source mapping to pause polling and invocation.
event_source_arnstringThe Amazon Resource Name (ARN) of the event source.
filter_criteriaobjectThe filter criteria to control event filtering.
function_namestringThe name of the Lambda function.
maximum_batching_window_in_secondsinteger(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
maximum_record_age_in_secondsinteger(Streams) The maximum age of a record that Lambda sends to a function for processing.
maximum_retry_attemptsinteger(Streams) The maximum number of times to retry when the function returns an error.
parallelization_factorinteger(Streams) The number of batches to process from each shard concurrently.
starting_positionstringThe position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
starting_position_timestampnumberWith StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
topicsarray(Kafka) A list of Kafka topics.
queuesarray(ActiveMQ) A list of ActiveMQ queues.
source_access_configurationsarrayA list of SourceAccessConfiguration.
tumbling_window_in_secondsinteger(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
function_response_typesarray(Streams) A list of response types supported by the function.
self_managed_event_sourceobjectSelf-managed event source endpoints.
amazon_managed_kafka_event_source_configobjectSpecific configuration settings for an MSK event source.
self_managed_kafka_event_source_configobjectSpecific configuration settings for a Self-Managed Apache Kafka event source.
scaling_configobjectThe scaling configuration for the event source.
document_db_event_source_configobjectDocument db event source config.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_source_mapping resource, the following permissions are required: + +### Delete +
+lambda:DeleteEventSourceMapping,
+lambda:GetEventSourceMapping
+ +### Read +
+lambda:GetEventSourceMapping
+ +### Update +
+lambda:UpdateEventSourceMapping,
+lambda:GetEventSourceMapping
+ + +## Example +```sql +SELECT +region, +id, +batch_size, +bisect_batch_on_function_error, +destination_config, +enabled, +event_source_arn, +filter_criteria, +function_name, +maximum_batching_window_in_seconds, +maximum_record_age_in_seconds, +maximum_retry_attempts, +parallelization_factor, +starting_position, +starting_position_timestamp, +topics, +queues, +source_access_configurations, +tumbling_window_in_seconds, +function_response_types, +self_managed_event_source, +amazon_managed_kafka_event_source_config, +self_managed_kafka_event_source_config, +scaling_config, +document_db_event_source_config +FROM awscc.lambda.event_source_mapping +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/event_source_mappings/index.md b/docs/awscc-docs/providers/awscc/lambda/event_source_mappings/index.md new file mode 100644 index 0000000000..03c12a0b5b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/event_source_mappings/index.md @@ -0,0 +1,59 @@ +--- +title: event_source_mappings +hide_title: false +hide_table_of_contents: false +keywords: + - event_source_mappings + - 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 +--- +Retrieves a list of event_source_mappings in a region + +## Overview + + + + + +
Nameevent_source_mappings
TypeResource
Descriptionevent_source_mappings
Idawscc.lambda.event_source_mappings
+ +## Fields + + + + + +
NameDatatypeDescription
idstringEvent Source Mapping Identifier UUID.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_source_mappings resource, the following permissions are required: + +### Create +
+lambda:CreateEventSourceMapping,
+lambda:GetEventSourceMapping
+ +### List +
+lambda:ListEventSourceMappings
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.lambda.event_source_mappings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/function/index.md b/docs/awscc-docs/providers/awscc/lambda/function/index.md new file mode 100644 index 0000000000..41ad28e1c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/function/index.md @@ -0,0 +1,147 @@ +--- +title: function +hide_title: false +hide_table_of_contents: false +keywords: + - function + - 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 +--- +Gets an individual function resource + +## Overview + + + + + +
Namefunction
TypeResource
Descriptionfunction
Idawscc.lambda.function
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA description of the function.
tracing_configobjectSet ``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).
vpc_configobjectFor 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).
runtime_management_configobjectSets 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).
reserved_concurrent_executionsintegerThe number of simultaneous executions to reserve for the function.
snap_startobjectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
file_system_configsarrayConnection 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.<br/> For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).
function_namestringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.<br/> 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.
runtimestringThe 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.<br/> 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).
kms_key_arnstringThe 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.
package_typestringThe type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.
code_signing_config_arnstringTo 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.
layersarrayA 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.
tagsarrayA list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
image_configobjectConfiguration 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).
memory_sizeintegerThe 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.
dead_letter_configobjectA 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).
timeoutintegerThe 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).
handlerstringThe 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).
snap_start_responseobject
codeobjectThe code for the function.
rolestringThe Amazon Resource Name (ARN) of the function's execution role.
logging_configobjectThe function's Amazon CloudWatch Logs configuration settings.
environmentobjectEnvironment variables that are accessible from function code during execution.
arnstring
ephemeral_storageobjectThe 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.
architecturesarrayThe 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``.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the function resource, the following permissions are required: + +### Read +
+lambda:GetFunction,
+lambda:GetFunctionCodeSigningConfig
+ +### Update +
+lambda:DeleteFunctionConcurrency,
+lambda:GetFunction,
+lambda:PutFunctionConcurrency,
+lambda:ListTags,
+lambda:TagResource,
+lambda:UntagResource,
+lambda:UpdateFunctionConfiguration,
+lambda:UpdateFunctionCode,
+iam:PassRole,
+s3:GetObject,
+s3:GetObjectVersion,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+elasticfilesystem:DescribeMountTargets,
+kms:CreateGrant,
+kms:Decrypt,
+kms:GenerateDataKey,
+lambda:GetRuntimeManagementConfig,
+lambda:PutRuntimeManagementConfig,
+lambda:PutFunctionCodeSigningConfig,
+lambda:DeleteFunctionCodeSigningConfig,
+lambda:GetCodeSigningConfig,
+lambda:GetFunctionCodeSigningConfig,
+lambda:GetPolicy,
+lambda:AddPermission,
+lambda:RemovePermission,
+lambda:GetResourcePolicy,
+lambda:PutResourcePolicy,
+lambda:DeleteResourcePolicy
+ +### Delete +
+lambda:DeleteFunction,
+lambda:GetFunction,
+ec2:DescribeNetworkInterfaces
+ + +## Example +```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, +tags, +image_config, +memory_size, +dead_letter_config, +timeout, +handler, +snap_start_response, +code, +role, +logging_config, +environment, +arn, +ephemeral_storage, +architectures +FROM awscc.lambda.function +WHERE region = 'us-east-1' +AND data__Identifier = '<FunctionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/functions/index.md b/docs/awscc-docs/providers/awscc/lambda/functions/index.md new file mode 100644 index 0000000000..f5f989e20f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/functions/index.md @@ -0,0 +1,82 @@ +--- +title: functions +hide_title: false +hide_table_of_contents: false +keywords: + - functions + - 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 +--- +Retrieves a list of functions in a region + +## Overview + + + + + +
Namefunctions
TypeResource
Descriptionfunctions
Idawscc.lambda.functions
+ +## Fields + + + + + +
NameDatatypeDescription
function_namestringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.<br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the functions resource, the following permissions are required: + +### Create +
+lambda:CreateFunction,
+lambda:GetFunction,
+lambda:PutFunctionConcurrency,
+iam:PassRole,
+s3:GetObject,
+s3:GetObjectVersion,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+elasticfilesystem:DescribeMountTargets,
+kms:CreateGrant,
+kms:Decrypt,
+kms:Encrypt,
+kms:GenerateDataKey,
+lambda:GetCodeSigningConfig,
+lambda:GetFunctionCodeSigningConfig,
+lambda:GetLayerVersion,
+lambda:GetRuntimeManagementConfig,
+lambda:PutRuntimeManagementConfig,
+lambda:TagResource,
+lambda:GetPolicy,
+lambda:AddPermission,
+lambda:RemovePermission,
+lambda:GetResourcePolicy,
+lambda:PutResourcePolicy
+ +### List +
+lambda:ListFunctions
+ + +## Example +```sql +SELECT +region, +function_name +FROM awscc.lambda.functions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/index.md b/docs/awscc-docs/providers/awscc/lambda/index.md new file mode 100644 index 0000000000..d2cb366041 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/index.md @@ -0,0 +1,55 @@ +--- +title: lambda +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The lambda service documentation. + +:::info Service Summary + +
+
+total resources: 18
+total selectable resources: 18
+total methods: 18
+
+
+ +::: + +## Resources +
+
+code_signing_config
+code_signing_configs
+event_invoke_config
+event_invoke_configs
+event_source_mapping
+event_source_mappings
+function
+functions
+layer_version +
+
+layer_version_permission
+layer_version_permissions
+layer_versions
+permission
+permissions
+url
+urls
+version
+versions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/lambda/layer_version/index.md b/docs/awscc-docs/providers/awscc/lambda/layer_version/index.md new file mode 100644 index 0000000000..5018fb9b4a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/layer_version/index.md @@ -0,0 +1,72 @@ +--- +title: layer_version +hide_title: false +hide_table_of_contents: false +keywords: + - layer_version + - 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 +--- +Gets an individual layer_version resource + +## Overview + + + + + +
Namelayer_version
TypeResource
Descriptionlayer_version
Idawscc.lambda.layer_version
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
compatible_runtimesarrayA list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
license_infostringThe layer's software license.
descriptionstringThe description of the version.
layer_namestringThe name or Amazon Resource Name (ARN) of the layer.
contentobjectThe function layer archive.
layer_version_arnstring
compatible_architecturesarrayA list of compatible instruction set architectures.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the layer_version resource, the following permissions are required: + +### Read +
+lambda:GetLayerVersion
+ +### Delete +
+lambda:GetLayerVersion,
+lambda:DeleteLayerVersion
+ + +## Example +```sql +SELECT +region, +compatible_runtimes, +license_info, +description, +layer_name, +content, +layer_version_arn, +compatible_architectures +FROM awscc.lambda.layer_version +WHERE region = 'us-east-1' +AND data__Identifier = '<LayerVersionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/layer_version_permission/index.md b/docs/awscc-docs/providers/awscc/lambda/layer_version_permission/index.md new file mode 100644 index 0000000000..3ef3ff6ba8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/layer_version_permission/index.md @@ -0,0 +1,68 @@ +--- +title: layer_version_permission +hide_title: false +hide_table_of_contents: false +keywords: + - layer_version_permission + - 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 +--- +Gets an individual layer_version_permission resource + +## Overview + + + + + +
Namelayer_version_permission
TypeResource
Descriptionlayer_version_permission
Idawscc.lambda.layer_version_permission
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstringID generated by service
actionstringThe API action that grants access to the layer.
layer_version_arnstringThe name or Amazon Resource Name (ARN) of the layer.
organization_idstringWith the principal set to *, grant permission to all accounts in the specified organization.
principalstringAn account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the layer_version_permission resource, the following permissions are required: + +### Read +
+lambda:GetLayerVersionPolicy
+ +### Delete +
+lambda:GetLayerVersionPolicy,
+lambda:RemoveLayerVersionPermission
+ + +## Example +```sql +SELECT +region, +id, +action, +layer_version_arn, +organization_id, +principal +FROM awscc.lambda.layer_version_permission +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/layer_version_permissions/index.md b/docs/awscc-docs/providers/awscc/lambda/layer_version_permissions/index.md new file mode 100644 index 0000000000..7864b4904d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/layer_version_permissions/index.md @@ -0,0 +1,58 @@ +--- +title: layer_version_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - layer_version_permissions + - 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 +--- +Retrieves a list of layer_version_permissions in a region + +## Overview + + + + + +
Namelayer_version_permissions
TypeResource
Descriptionlayer_version_permissions
Idawscc.lambda.layer_version_permissions
+ +## Fields + + + + + +
NameDatatypeDescription
idstringID generated by service
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the layer_version_permissions resource, the following permissions are required: + +### Create +
+lambda:AddLayerVersionPermission
+ +### List +
+lambda:GetLayerVersionPolicy
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.lambda.layer_version_permissions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md b/docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md new file mode 100644 index 0000000000..fd0e20cf8c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md @@ -0,0 +1,60 @@ +--- +title: layer_versions +hide_title: false +hide_table_of_contents: false +keywords: + - layer_versions + - 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 +--- +Retrieves a list of layer_versions in a region + +## Overview + + + + + +
Namelayer_versions
TypeResource
Descriptionlayer_versions
Idawscc.lambda.layer_versions
+ +## Fields + + + + + +
NameDatatypeDescription
layer_version_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the layer_versions resource, the following permissions are required: + +### Create +
+lambda:PublishLayerVersion,
+s3:GetObject,
+s3:GetObjectVersion
+ +### List +
+lambda:ListLayerVersions
+ + +## Example +```sql +SELECT +region, +layer_version_arn +FROM awscc.lambda.layer_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/permission/index.md b/docs/awscc-docs/providers/awscc/lambda/permission/index.md new file mode 100644 index 0000000000..270ddbb44d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/permission/index.md @@ -0,0 +1,76 @@ +--- +title: permission +hide_title: false +hide_table_of_contents: false +keywords: + - permission + - 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 +--- +Gets an individual permission resource + +## Overview + + + + + +
Namepermission
TypeResource
Descriptionpermission
Idawscc.lambda.permission
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
actionstringThe action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.
event_source_tokenstringFor Alexa Smart Home functions, a token that the invoker must supply.
function_namestringThe name of the Lambda function, version, or alias.<br/> **Name formats**<br/> + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias).<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.<br/> + *Partial ARN* – ``123456789012:function:my-function``.<br/> <br/> 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.
function_url_auth_typestringThe 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).
principalstringThe 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.
principal_org_idstringThe identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
source_accountstringFor 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.
source_arnstringFor AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.<br/> Note that Lambda configures the comparison using the ``StringLike`` operator.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permission resource, the following permissions are required: + +### Read +
+lambda:GetPolicy
+ +### Delete +
+lambda:RemovePermission
+ + +## Example +```sql +SELECT +region, +id, +action, +event_source_token, +function_name, +function_url_auth_type, +principal, +principal_org_id, +source_account, +source_arn +FROM awscc.lambda.permission +WHERE region = 'us-east-1' +AND data__Identifier = '<FunctionName>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/permissions/index.md b/docs/awscc-docs/providers/awscc/lambda/permissions/index.md new file mode 100644 index 0000000000..f3b4e3440e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/permissions/index.md @@ -0,0 +1,60 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - permissions + - 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 +--- +Retrieves a list of permissions in a region + +## Overview + + + + + +
Namepermissions
TypeResource
Descriptionpermissions
Idawscc.lambda.permissions
+ +## Fields + + + + + + +
NameDatatypeDescription
function_namestringThe name of the Lambda function, version, or alias.<br/> **Name formats**<br/> + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias).<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.<br/> + *Partial ARN* – ``123456789012:function:my-function``.<br/> <br/> 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.
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +
+lambda:AddPermission
+ +### List +
+lambda:GetPolicy
+ + +## Example +```sql +SELECT +region, +function_name, +id +FROM awscc.lambda.permissions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/url/index.md b/docs/awscc-docs/providers/awscc/lambda/url/index.md new file mode 100644 index 0000000000..6789ce035e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/url/index.md @@ -0,0 +1,75 @@ +--- +title: url +hide_title: false +hide_table_of_contents: false +keywords: + - url + - 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 +--- +Gets an individual url resource + +## Overview + + + + + +
Nameurl
TypeResource
Descriptionurl
Idawscc.lambda.url
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
target_function_arnstringThe Amazon Resource Name (ARN) of the function associated with the Function URL.
qualifierstringThe alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
auth_typestringCan be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
invoke_modestringThe 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.
function_arnstringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
function_urlstringThe generated url for this resource.
corsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the url resource, the following permissions are required: + +### Read +
+lambda:GetFunctionUrlConfig
+ +### Update +
+lambda:UpdateFunctionUrlConfig
+ +### Delete +
+lambda:DeleteFunctionUrlConfig
+ + +## Example +```sql +SELECT +region, +target_function_arn, +qualifier, +auth_type, +invoke_mode, +function_arn, +function_url, +cors +FROM awscc.lambda.url +WHERE region = 'us-east-1' +AND data__Identifier = '<FunctionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/urls/index.md b/docs/awscc-docs/providers/awscc/lambda/urls/index.md new file mode 100644 index 0000000000..64469fb640 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/urls/index.md @@ -0,0 +1,58 @@ +--- +title: urls +hide_title: false +hide_table_of_contents: false +keywords: + - urls + - 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 +--- +Retrieves a list of urls in a region + +## Overview + + + + + +
Nameurls
TypeResource
Descriptionurls
Idawscc.lambda.urls
+ +## Fields + + + + + +
NameDatatypeDescription
function_arnstringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the urls resource, the following permissions are required: + +### Create +
+lambda:CreateFunctionUrlConfig
+ +### List +
+lambda:ListFunctionUrlConfigs
+ + +## Example +```sql +SELECT +region, +function_arn +FROM awscc.lambda.urls +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/version/index.md b/docs/awscc-docs/providers/awscc/lambda/version/index.md new file mode 100644 index 0000000000..8384f0523f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/version/index.md @@ -0,0 +1,78 @@ +--- +title: version +hide_title: false +hide_table_of_contents: false +keywords: + - version + - 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 +--- +Gets an individual version resource + +## Overview + + + + + +
Nameversion
TypeResource
Descriptionversion
Idawscc.lambda.version
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
function_arnstringThe ARN of the version.
versionstringThe version number.
code_sha256stringOnly 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.
descriptionstringA description for the version to override the description in the function configuration. Updates are not supported for this property.
function_namestringThe name of the Lambda function.
provisioned_concurrency_configobjectSpecifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property.
runtime_policyobjectSpecifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the version resource, the following permissions are required: + +### Read +
+lambda:GetFunctionConfiguration,
+lambda:GetProvisionedConcurrencyConfig,
+lambda:GetRuntimeManagementConfig
+ +### Delete +
+lambda:GetFunctionConfiguration,
+lambda:DeleteFunction
+ +### Update +
+
+ + +## Example +```sql +SELECT +region, +function_arn, +version, +code_sha256, +description, +function_name, +provisioned_concurrency_config, +runtime_policy +FROM awscc.lambda.version +WHERE region = 'us-east-1' +AND data__Identifier = '<FunctionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/lambda/versions/index.md b/docs/awscc-docs/providers/awscc/lambda/versions/index.md new file mode 100644 index 0000000000..dea6c96db5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lambda/versions/index.md @@ -0,0 +1,63 @@ +--- +title: versions +hide_title: false +hide_table_of_contents: false +keywords: + - versions + - 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 +--- +Retrieves a list of versions in a region + +## Overview + + + + + +
Nameversions
TypeResource
Descriptionversions
Idawscc.lambda.versions
+ +## Fields + + + + + +
NameDatatypeDescription
function_arnstringThe ARN of the version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the versions resource, the following permissions are required: + +### Create +
+lambda:PublishVersion,
+lambda:GetFunctionConfiguration,
+lambda:PutProvisionedConcurrencyConfig,
+lambda:GetProvisionedConcurrencyConfig,
+lambda:PutRuntimeManagementConfig,
+lambda:GetRuntimeManagementConfig
+ +### List +
+lambda:ListVersionsByFunction
+ + +## Example +```sql +SELECT +region, +function_arn +FROM awscc.lambda.versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/bot/index.md b/docs/awscc-docs/providers/awscc/lex/bot/index.md new file mode 100644 index 0000000000..7a3326d320 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/bot/index.md @@ -0,0 +1,127 @@ +--- +title: bot +hide_title: false +hide_table_of_contents: false +keywords: + - bot + - 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 +--- +Gets an individual bot resource + +## Overview + + + + + +
Namebot
TypeResource
Descriptionbot
Idawscc.lex.bot
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestring
descriptionstring
role_arnstring
data_privacyobjectData privacy setting of the Bot.
idle_session_tt_lin_secondsintegerIdleSessionTTLInSeconds of the resource
bot_localesarrayList of bot locales
bot_file_s3_locationobject
bot_tagsarrayA list of tags to add to the bot, which can only be added at bot creation.
test_bot_alias_tagsarrayA list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation.
auto_build_bot_localesbooleanSpecifies whether to build the bot locales after bot creation completes.
test_bot_alias_settingsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bot resource, the following permissions are required: + +### Read +
+lex:DescribeBot,
+lex:ListTagsForResource
+ +### Update +
+iam:PassRole,
+lex:DescribeBot,
+lex:CreateUploadUrl,
+lex:StartImport,
+lex:DescribeImport,
+lex:ListTagsForResource,
+lex:TagResource,
+lex:UntagResource,
+lex:CreateBot,
+lex:CreateBotLocale,
+lex:CreateIntent,
+lex:CreateSlot,
+lex:CreateSlotType,
+lex:UpdateBot,
+lex:UpdateBotLocale,
+lex:UpdateIntent,
+lex:UpdateSlot,
+lex:UpdateSlotType,
+lex:DeleteBotLocale,
+lex:DeleteIntent,
+lex:DeleteSlot,
+lex:DeleteSlotType,
+lex:DescribeBotLocale,
+lex:BuildBotLocale,
+lex:ListBots,
+lex:ListBotLocales,
+lex:CreateCustomVocabulary,
+lex:UpdateCustomVocabulary,
+lex:DeleteCustomVocabulary,
+s3:GetObject,
+lex:UpdateBotAlias
+ +### Delete +
+lex:DeleteBot,
+lex:DescribeBot,
+lex:DeleteBotLocale,
+lex:DeleteIntent,
+lex:DeleteSlotType,
+lex:DeleteSlot,
+lex:DeleteBotVersion,
+lex:DeleteBotChannel,
+lex:DeleteBotAlias,
+lex:DeleteCustomVocabulary
+ + +## Example +```sql +SELECT +region, +id, +arn, +name, +description, +role_arn, +data_privacy, +idle_session_tt_lin_seconds, +bot_locales, +bot_file_s3_location, +bot_tags, +test_bot_alias_tags, +auto_build_bot_locales, +test_bot_alias_settings +FROM awscc.lex.bot +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/bot_alias/index.md b/docs/awscc-docs/providers/awscc/lex/bot_alias/index.md new file mode 100644 index 0000000000..a131d1ee57 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/bot_alias/index.md @@ -0,0 +1,88 @@ +--- +title: bot_alias +hide_title: false +hide_table_of_contents: false +keywords: + - bot_alias + - 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 +--- +Gets an individual bot_alias resource + +## Overview + + + + + +
Namebot_alias
TypeResource
Descriptionbot_alias
Idawscc.lex.bot_alias
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
bot_alias_idstring
bot_idstring
arnstring
bot_alias_statusstring
bot_alias_locale_settingsarray
bot_alias_namestring
bot_versionobject
conversation_log_settingsobject
descriptionstring
sentiment_analysis_settingsobjectDetermines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
bot_alias_tagsarrayA list of tags to add to the bot alias.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bot_alias resource, the following permissions are required: + +### Update +
+lex:UpdateBotAlias,
+lex:DescribeBotAlias,
+lex:ListTagsForResource,
+lex:TagResource,
+lex:UntagResource
+ +### Read +
+lex:DescribeBotAlias
+ +### Delete +
+lex:DeleteBotAlias
+ + +## Example +```sql +SELECT +region, +bot_alias_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 awscc.lex.bot_alias +WHERE region = 'us-east-1' +AND data__Identifier = '<BotAliasId>' +AND data__Identifier = '<BotId>' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md b/docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md new file mode 100644 index 0000000000..a54b01a7f2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md @@ -0,0 +1,61 @@ +--- +title: bot_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - bot_aliases + - 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 +--- +Retrieves a list of bot_aliases in a region + +## Overview + + + + + +
Namebot_aliases
TypeResource
Descriptionbot_aliases
Idawscc.lex.bot_aliases
+ +## Fields + + + + + + +
NameDatatypeDescription
bot_alias_idundefined
bot_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bot_aliases resource, the following permissions are required: + +### Create +
+lex:CreateBotAlias,
+lex:DescribeBot
+ +### List +
+lex:ListBotAliases
+ + +## Example +```sql +SELECT +region, +bot_alias_id, +bot_id +FROM awscc.lex.bot_aliases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/bot_version/index.md b/docs/awscc-docs/providers/awscc/lex/bot_version/index.md new file mode 100644 index 0000000000..aecdadb1f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/bot_version/index.md @@ -0,0 +1,67 @@ +--- +title: bot_version +hide_title: false +hide_table_of_contents: false +keywords: + - bot_version + - 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 +--- +Gets an individual bot_version resource + +## Overview + + + + + +
Namebot_version
TypeResource
Descriptionbot_version
Idawscc.lex.bot_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
bot_idstring
bot_versionobject
descriptionstring
bot_version_locale_specificationarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bot_version resource, the following permissions are required: + +### Read +
+lex:DescribeBotVersion
+ +### Delete +
+lex:DeleteBotVersion,
+lex:DescribeBotVersion
+ + +## Example +```sql +SELECT +region, +bot_id, +bot_version, +description, +bot_version_locale_specification +FROM awscc.lex.bot_version +WHERE region = 'us-east-1' +AND data__Identifier = '<BotId>' +AND data__Identifier = '<BotVersion>' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/bot_versions/index.md b/docs/awscc-docs/providers/awscc/lex/bot_versions/index.md new file mode 100644 index 0000000000..594d472efc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/bot_versions/index.md @@ -0,0 +1,64 @@ +--- +title: bot_versions +hide_title: false +hide_table_of_contents: false +keywords: + - bot_versions + - 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 +--- +Retrieves a list of bot_versions in a region + +## Overview + + + + + +
Namebot_versions
TypeResource
Descriptionbot_versions
Idawscc.lex.bot_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
bot_idundefined
bot_versionundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bot_versions resource, the following permissions are required: + +### Create +
+lex:CreateBotVersion,
+lex:DescribeBotVersion,
+lex:DescribeBot,
+lex:DescribeBotLocale,
+lex:BuildBotLocale
+ +### List +
+lex:ListBotVersions
+ + +## Example +```sql +SELECT +region, +bot_id, +bot_version +FROM awscc.lex.bot_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/bots/index.md b/docs/awscc-docs/providers/awscc/lex/bots/index.md new file mode 100644 index 0000000000..de9fdc20a1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/bots/index.md @@ -0,0 +1,87 @@ +--- +title: bots +hide_title: false +hide_table_of_contents: false +keywords: + - bots + - 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 +--- +Retrieves a list of bots in a region + +## Overview + + + + + +
Namebots
TypeResource
Descriptionbots
Idawscc.lex.bots
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bots resource, the following permissions are required: + +### Create +
+iam:PassRole,
+lex:DescribeBot,
+lex:CreateUploadUrl,
+lex:StartImport,
+lex:DescribeImport,
+lex:ListTagsForResource,
+lex:TagResource,
+lex:CreateBot,
+lex:CreateBotLocale,
+lex:CreateIntent,
+lex:CreateSlot,
+lex:CreateSlotType,
+lex:UpdateBot,
+lex:UpdateBotLocale,
+lex:UpdateIntent,
+lex:UpdateSlot,
+lex:UpdateSlotType,
+lex:DeleteBotLocale,
+lex:DeleteIntent,
+lex:DeleteSlot,
+lex:DeleteSlotType,
+lex:DescribeBotLocale,
+lex:BuildBotLocale,
+lex:ListBots,
+lex:ListBotLocales,
+lex:CreateCustomVocabulary,
+lex:UpdateCustomVocabulary,
+lex:DeleteCustomVocabulary,
+s3:GetObject,
+lex:UpdateBotAlias
+ +### List +
+lex:ListBots
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.lex.bots +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/index.md b/docs/awscc-docs/providers/awscc/lex/index.md new file mode 100644 index 0000000000..916c282dd1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/index.md @@ -0,0 +1,45 @@ +--- +title: lex +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The lex service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+bot
+bot_alias
+bot_aliases
+bot_version +
+
+bot_versions
+bots
+resource_policies
+resource_policy +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/lex/resource_policies/index.md b/docs/awscc-docs/providers/awscc/lex/resource_policies/index.md new file mode 100644 index 0000000000..9ffcb5459e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/resource_policies/index.md @@ -0,0 +1,59 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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 +--- +Retrieves a list of resource_policies in a region + +## Overview + + + + + +
Nameresource_policies
TypeResource
Descriptionresource_policies
Idawscc.lex.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +
+lex:CreateResourcePolicy,
+lex:DescribeResourcePolicy
+ +### List +
+lex:DescribeResourcePolicy
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.lex.resource_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lex/resource_policy/index.md b/docs/awscc-docs/providers/awscc/lex/resource_policy/index.md new file mode 100644 index 0000000000..65a310f32e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lex/resource_policy/index.md @@ -0,0 +1,71 @@ +--- +title: resource_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy + - 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 +--- +Gets an individual resource_policy resource + +## Overview + + + + + +
Nameresource_policy
TypeResource
Descriptionresource_policy
Idawscc.lex.resource_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
resource_arnstring
revision_idstring
policyobject
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +
+lex:DescribeResourcePolicy
+ +### Update +
+lex:UpdateResourcePolicy,
+lex:DescribeResourcePolicy
+ +### Delete +
+lex:DeleteResourcePolicy,
+lex:DescribeResourcePolicy
+ + +## Example +```sql +SELECT +region, +resource_arn, +revision_id, +policy, +id +FROM awscc.lex.resource_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/licensemanager/grant/index.md b/docs/awscc-docs/providers/awscc/licensemanager/grant/index.md new file mode 100644 index 0000000000..5174d95f23 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/licensemanager/grant/index.md @@ -0,0 +1,77 @@ +--- +title: grant +hide_title: false +hide_table_of_contents: false +keywords: + - grant + - 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 +--- +Gets an individual grant resource + +## Overview + + + + + +
Namegrant
TypeResource
Descriptiongrant
Idawscc.licensemanager.grant
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
grant_arnstringArn of the grant.
grant_namestringName for the created Grant.
license_arnstringLicense Arn for the grant.
home_regionstringHome region for the created grant.
versionstringThe version of the grant.
allowed_operationsarray
principalsarray
statusstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the grant resource, the following permissions are required: + +### Read +
+license-manager:GetGrant
+ +### Update +
+license-manager:CreateGrantVersion
+ +### Delete +
+license-manager:DeleteGrant
+ + +## Example +```sql +SELECT +region, +grant_arn, +grant_name, +license_arn, +home_region, +version, +allowed_operations, +principals, +status +FROM awscc.licensemanager.grant +WHERE region = 'us-east-1' +AND data__Identifier = '<GrantArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/licensemanager/grants/index.md b/docs/awscc-docs/providers/awscc/licensemanager/grants/index.md new file mode 100644 index 0000000000..a3fc5e7fcf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/licensemanager/grants/index.md @@ -0,0 +1,58 @@ +--- +title: grants +hide_title: false +hide_table_of_contents: false +keywords: + - grants + - 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 +--- +Retrieves a list of grants in a region + +## Overview + + + + + +
Namegrants
TypeResource
Descriptiongrants
Idawscc.licensemanager.grants
+ +## Fields + + + + + +
NameDatatypeDescription
grant_arnundefinedArn of the grant.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the grants resource, the following permissions are required: + +### Create +
+license-manager:CreateGrant
+ +### List +
+license-manager:ListDistributedGrants
+ + +## Example +```sql +SELECT +region, +grant_arn +FROM awscc.licensemanager.grants +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/licensemanager/index.md b/docs/awscc-docs/providers/awscc/licensemanager/index.md new file mode 100644 index 0000000000..ef4da62208 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/licensemanager/index.md @@ -0,0 +1,41 @@ +--- +title: licensemanager +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The licensemanager service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+grant
+grants +
+
+license
+licenses +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/licensemanager/license/index.md b/docs/awscc-docs/providers/awscc/licensemanager/license/index.md new file mode 100644 index 0000000000..39b43aea7d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/licensemanager/license/index.md @@ -0,0 +1,87 @@ +--- +title: license +hide_title: false +hide_table_of_contents: false +keywords: + - license + - 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 +--- +Gets an individual license resource + +## Overview + + + + + +
Namelicense
TypeResource
Descriptionlicense
Idawscc.licensemanager.license
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
product_sk_ustringProductSKU of the license.
issuerobject
license_namestringName for the created license.
product_namestringProduct name for the created license.
home_regionstringHome region for the created license.
validityobject
entitlementsarray
beneficiarystringBeneficiary of the license.
consumption_configurationobject
license_metadataarray
license_arnstringAmazon Resource Name is a unique name for each resource.
statusstring
versionstringThe version of the license.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the license resource, the following permissions are required: + +### Read +
+license-manager:GetLicense
+ +### Update +
+license-manager:CreateLicenseVersion
+ +### Delete +
+license-manager:DeleteLicense
+ + +## Example +```sql +SELECT +region, +product_sk_u, +issuer, +license_name, +product_name, +home_region, +validity, +entitlements, +beneficiary, +consumption_configuration, +license_metadata, +license_arn, +status, +version +FROM awscc.licensemanager.license +WHERE region = 'us-east-1' +AND data__Identifier = '<LicenseArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md b/docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md new file mode 100644 index 0000000000..346132602c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md @@ -0,0 +1,58 @@ +--- +title: licenses +hide_title: false +hide_table_of_contents: false +keywords: + - licenses + - 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 +--- +Retrieves a list of licenses in a region + +## Overview + + + + + +
Namelicenses
TypeResource
Descriptionlicenses
Idawscc.licensemanager.licenses
+ +## Fields + + + + + +
NameDatatypeDescription
license_arnundefinedAmazon Resource Name is a unique name for each resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the licenses resource, the following permissions are required: + +### Create +
+license-manager:CreateLicense
+ +### List +
+license-manager:ListLicenses
+ + +## Example +```sql +SELECT +region, +license_arn +FROM awscc.licensemanager.licenses +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/alarm/index.md b/docs/awscc-docs/providers/awscc/lightsail/alarm/index.md new file mode 100644 index 0000000000..366496480f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/alarm/index.md @@ -0,0 +1,89 @@ +--- +title: alarm +hide_title: false +hide_table_of_contents: false +keywords: + - alarm + - 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 +--- +Gets an individual alarm resource + +## Overview + + + + + +
Namealarm
TypeResource
Descriptionalarm
Idawscc.lightsail.alarm
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
alarm_namestringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
monitored_resource_namestringThe validation status of the SSL/TLS certificate.
metric_namestringThe name of the metric to associate with the alarm.
comparison_operatorstringThe arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contact_protocolsarrayThe contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
alarm_arnstring
datapoints_to_alarmintegerThe 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.
evaluation_periodsintegerThe 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.
notification_enabledbooleanIndicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
notification_triggersarrayThe alarm states that trigger a notification.
thresholdnumberThe value against which the specified statistic is compared.
treat_missing_datastringSets how this alarm will handle missing data points.
statestringThe current state of the alarm.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alarm resource, the following permissions are required: + +### Read +
+lightsail:GetAlarms
+ +### Update +
+lightsail:PutAlarm,
+lightsail:GetAlarms
+ +### Delete +
+lightsail:DeleteAlarm,
+lightsail:GetAlarms
+ + +## Example +```sql +SELECT +region, +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 awscc.lightsail.alarm +WHERE region = 'us-east-1' +AND data__Identifier = '<AlarmName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/alarms/index.md b/docs/awscc-docs/providers/awscc/lightsail/alarms/index.md new file mode 100644 index 0000000000..e6aef4b233 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/alarms/index.md @@ -0,0 +1,59 @@ +--- +title: alarms +hide_title: false +hide_table_of_contents: false +keywords: + - alarms + - 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 +--- +Retrieves a list of alarms in a region + +## Overview + + + + + +
Namealarms
TypeResource
Descriptionalarms
Idawscc.lightsail.alarms
+ +## Fields + + + + + +
NameDatatypeDescription
alarm_namestringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alarms resource, the following permissions are required: + +### Create +
+lightsail:PutAlarm,
+lightsail:GetAlarms
+ +### List +
+lightsail:GetAlarms
+ + +## Example +```sql +SELECT +region, +alarm_name +FROM awscc.lightsail.alarms +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/bucket/index.md b/docs/awscc-docs/providers/awscc/lightsail/bucket/index.md new file mode 100644 index 0000000000..9439d768f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/bucket/index.md @@ -0,0 +1,88 @@ +--- +title: bucket +hide_title: false +hide_table_of_contents: false +keywords: + - bucket + - 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 +--- +Gets an individual bucket resource + +## Overview + + + + + +
Namebucket
TypeResource
Descriptionbucket
Idawscc.lightsail.bucket
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
bucket_namestringThe name for the bucket.
bundle_idstringThe ID of the bundle to use for the bucket.
bucket_arnstring
object_versioningbooleanSpecifies whether to enable or disable versioning of objects in the bucket.
access_rulesobject
resources_receiving_accessarrayThe names of the Lightsail resources for which to set bucket access.
read_only_access_accountsarrayAn array of strings to specify the AWS account IDs that can access the bucket.
tagsarrayAn array of key-value pairs to apply to this resource.
urlstringThe URL of the bucket.
able_to_update_bundlebooleanIndicates 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket resource, the following permissions are required: + +### Read +
+lightsail:GetBuckets
+ +### Delete +
+lightsail:DeleteBucket,
+lightsail:GetBuckets
+ +### Update +
+lightsail:GetBuckets,
+lightsail:GetInstance,
+lightsail:UpdateBucket,
+lightsail:UpdateBucketBundle,
+lightsail:SetResourceAccessForBucket,
+lightsail:TagResource,
+lightsail:UntagResource
+ + +## Example +```sql +SELECT +region, +bucket_name, +bundle_id, +bucket_arn, +object_versioning, +access_rules, +resources_receiving_access, +read_only_access_accounts, +tags, +url, +able_to_update_bundle +FROM awscc.lightsail.bucket +WHERE region = 'us-east-1' +AND data__Identifier = '<BucketName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/buckets/index.md b/docs/awscc-docs/providers/awscc/lightsail/buckets/index.md new file mode 100644 index 0000000000..3a24654f37 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/buckets/index.md @@ -0,0 +1,65 @@ +--- +title: buckets +hide_title: false +hide_table_of_contents: false +keywords: + - buckets + - 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 +--- +Retrieves a list of buckets in a region + +## Overview + + + + + +
Namebuckets
TypeResource
Descriptionbuckets
Idawscc.lightsail.buckets
+ +## Fields + + + + + +
NameDatatypeDescription
bucket_namestringThe name for the bucket.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the buckets resource, the following permissions are required: + +### Create +
+lightsail:CreateBucket,
+lightsail:GetBuckets,
+lightsail:GetInstance,
+lightsail:UpdateBucket,
+lightsail:UpdateBucketBundle,
+lightsail:SetResourceAccessForBucket,
+lightsail:TagResource,
+lightsail:UntagResource
+ +### List +
+lightsail:GetBuckets
+ + +## Example +```sql +SELECT +region, +bucket_name +FROM awscc.lightsail.buckets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/certificate/index.md b/docs/awscc-docs/providers/awscc/lightsail/certificate/index.md new file mode 100644 index 0000000000..90c0bda4f0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/certificate/index.md @@ -0,0 +1,76 @@ +--- +title: certificate +hide_title: false +hide_table_of_contents: false +keywords: + - certificate + - 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 +--- +Gets an individual certificate resource + +## Overview + + + + + +
Namecertificate
TypeResource
Descriptioncertificate
Idawscc.lightsail.certificate
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
certificate_namestringThe name for the certificate.
domain_namestringThe domain name (e.g., example.com ) for the certificate.
subject_alternative_namesarrayAn array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
certificate_arnstring
statusstringThe validation status of the certificate.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +
+lightsail:GetCertificates
+ +### Update +
+lightsail:GetCertificates,
+lightsail:TagResource,
+lightsail:UntagResource
+ +### Delete +
+lightsail:DeleteCertificate,
+lightsail:GetCertificates
+ + +## Example +```sql +SELECT +region, +certificate_name, +domain_name, +subject_alternative_names, +certificate_arn, +status, +tags +FROM awscc.lightsail.certificate +WHERE region = 'us-east-1' +AND data__Identifier = '<CertificateName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/certificates/index.md b/docs/awscc-docs/providers/awscc/lightsail/certificates/index.md new file mode 100644 index 0000000000..96a3582269 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/certificates/index.md @@ -0,0 +1,61 @@ +--- +title: certificates +hide_title: false +hide_table_of_contents: false +keywords: + - certificates + - 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 +--- +Retrieves a list of certificates in a region + +## Overview + + + + + +
Namecertificates
TypeResource
Descriptioncertificates
Idawscc.lightsail.certificates
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_namestringThe name for the certificate.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +
+lightsail:CreateCertificate,
+lightsail:GetCertificates,
+lightsail:TagResource,
+lightsail:UntagResource
+ +### List +
+lightsail:GetCertificates
+ + +## Example +```sql +SELECT +region, +certificate_name +FROM awscc.lightsail.certificates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/container/index.md b/docs/awscc-docs/providers/awscc/lightsail/container/index.md new file mode 100644 index 0000000000..992ec8bcd1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/container/index.md @@ -0,0 +1,88 @@ +--- +title: container +hide_title: false +hide_table_of_contents: false +keywords: + - container + - 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 +--- +Gets an individual container resource + +## Overview + + + + + +
Namecontainer
TypeResource
Descriptioncontainer
Idawscc.lightsail.container
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
service_namestringThe name for the container service.
powerstringThe power specification for the container service.
container_arnstring
scaleintegerThe scale specification for the container service.
public_domain_namesarrayThe public domain names to use with the container service, such as example.com and www.example.com.
container_service_deploymentobjectDescribes a container deployment configuration of an Amazon Lightsail container service.
is_disabledbooleanA Boolean value to indicate whether the container service is disabled.
private_registry_accessobjectA 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.
urlstringThe publicly accessible URL of the container service.
principal_arnstringThe principal ARN of the container service.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the container resource, the following permissions are required: + +### Read +
+lightsail:GetContainerServices
+ +### Delete +
+lightsail:DeleteContainerService,
+lightsail:GetContainerServices
+ +### Update +
+lightsail:CreateContainerServiceDeployment,
+lightsail:GetContainerServices,
+lightsail:TagResource,
+lightsail:UntagResource,
+lightsail:UpdateContainerService
+ + +## Example +```sql +SELECT +region, +service_name, +power, +container_arn, +scale, +public_domain_names, +container_service_deployment, +is_disabled, +private_registry_access, +url, +principal_arn, +tags +FROM awscc.lightsail.container +WHERE region = 'us-east-1' +AND data__Identifier = '<ServiceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/containers/index.md b/docs/awscc-docs/providers/awscc/lightsail/containers/index.md new file mode 100644 index 0000000000..107c7c1dd5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/containers/index.md @@ -0,0 +1,63 @@ +--- +title: containers +hide_title: false +hide_table_of_contents: false +keywords: + - containers + - 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 +--- +Retrieves a list of containers in a region + +## Overview + + + + + +
Namecontainers
TypeResource
Descriptioncontainers
Idawscc.lightsail.containers
+ +## Fields + + + + + +
NameDatatypeDescription
service_namestringThe name for the container service.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the containers resource, the following permissions are required: + +### Create +
+lightsail:CreateContainerService,
+lightsail:CreateContainerServiceDeployment,
+lightsail:GetContainerServices,
+lightsail:TagResource,
+lightsail:UntagResource,
+lightsail:UpdateContainerService
+ +### List +
+lightsail:GetContainerServices
+ + +## Example +```sql +SELECT +region, +service_name +FROM awscc.lightsail.containers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/database/index.md b/docs/awscc-docs/providers/awscc/lightsail/database/index.md new file mode 100644 index 0000000000..34d6c9212d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/database/index.md @@ -0,0 +1,101 @@ +--- +title: database +hide_title: false +hide_table_of_contents: false +keywords: + - database + - 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 +--- +Gets an individual database resource + +## Overview + + + + + +
Namedatabase
TypeResource
Descriptiondatabase
Idawscc.lightsail.database
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
relational_database_namestringThe name to use for your new Lightsail database resource.
database_arnstring
availability_zonestringThe Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
relational_database_blueprint_idstringThe blueprint ID for your new database. A blueprint describes the major engine version of a database.
relational_database_bundle_idstringThe bundle ID for your new database. A bundle describes the performance specifications for your database.
master_database_namestringThe 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.
master_usernamestringThe name for the master user.
master_user_passwordstringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
preferred_backup_windowstringThe daily time range during which automated backups are created for your new database if automated backups are enabled.
preferred_maintenance_windowstringThe weekly time range during which system maintenance can occur on your new database.
publicly_accessiblebooleanSpecifies 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.
ca_certificate_identifierstringIndicates the certificate that needs to be associated with the database.
backup_retentionbooleanWhen true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
rotate_master_user_passwordbooleanWhen 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.
relational_database_parametersarrayUpdate one or more parameters of the relational database.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the database resource, the following permissions are required: + +### Read +
+lightsail:GetRelationalDatabase,
+lightsail:GetRelationalDatabases
+ +### Update +
+lightsail:GetRelationalDatabase,
+lightsail:GetRelationalDatabases,
+lightsail:TagResource,
+lightsail:UntagResource,
+lightsail:UpdateRelationalDatabase,
+lightsail:UpdateRelationalDatabaseParameters
+ +### Delete +
+lightsail:DeleteRelationalDatabase,
+lightsail:GetRelationalDatabase,
+lightsail:GetRelationalDatabases
+ + +## Example +```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, +tags +FROM awscc.lightsail.database +WHERE region = 'us-east-1' +AND data__Identifier = '<RelationalDatabaseName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/databases/index.md b/docs/awscc-docs/providers/awscc/lightsail/databases/index.md new file mode 100644 index 0000000000..c6d2bc4cfa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/databases/index.md @@ -0,0 +1,65 @@ +--- +title: databases +hide_title: false +hide_table_of_contents: false +keywords: + - databases + - 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 +--- +Retrieves a list of databases in a region + +## Overview + + + + + +
Namedatabases
TypeResource
Descriptiondatabases
Idawscc.lightsail.databases
+ +## Fields + + + + + +
NameDatatypeDescription
relational_database_namestringThe name to use for your new Lightsail database resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the databases resource, the following permissions are required: + +### Create +
+lightsail:CreateRelationalDatabase,
+lightsail:GetRelationalDatabase,
+lightsail:GetRelationalDatabases,
+lightsail:GetRegions,
+lightsail:TagResource,
+lightsail:UntagResource,
+lightsail:UpdateRelationalDatabase,
+lightsail:UpdateRelationalDatabaseParameters
+ +### List +
+lightsail:GetRelationalDatabases
+ + +## Example +```sql +SELECT +region, +relational_database_name +FROM awscc.lightsail.databases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/distribution/index.md b/docs/awscc-docs/providers/awscc/lightsail/distribution/index.md new file mode 100644 index 0000000000..11107ba982 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/distribution/index.md @@ -0,0 +1,96 @@ +--- +title: distribution +hide_title: false +hide_table_of_contents: false +keywords: + - distribution + - 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 +--- +Gets an individual distribution resource + +## Overview + + + + + +
Namedistribution
TypeResource
Descriptiondistribution
Idawscc.lightsail.distribution
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
distribution_namestringThe name for the distribution.
distribution_arnstring
bundle_idstringThe bundle ID to use for the distribution.
ip_address_typestringThe IP address type for the distribution.
cache_behaviorsarrayAn array of objects that describe the per-path cache behavior for the distribution.
cache_behavior_settingsobjectAn object that describes the cache behavior settings for the distribution.
default_cache_behaviorobjectAn object that describes the default cache behavior for the distribution.
originobjectAn object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
statusstringThe status of the distribution.
able_to_update_bundlebooleanIndicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
is_enabledbooleanIndicates whether the distribution is enabled.
certificate_namestringThe certificate attached to the Distribution.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the distribution resource, the following permissions are required: + +### Read +
+lightsail:GetDistributions
+ +### Update +
+lightsail:AttachCertificateToDistribution,
+lightsail:DetachCertificateFromDistribution,
+lightsail:GetCertificates,
+lightsail:GetCertificateDetails,
+lightsail:GetDistributions,
+lightsail:TagResource,
+lightsail:UntagResource,
+lightsail:UpdateDistribution,
+lightsail:UpdateDistributionBundle
+ +### Delete +
+lightsail:DeleteDistribution,
+lightsail:GetDistributions
+ + +## Example +```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, +tags +FROM awscc.lightsail.distribution +WHERE region = 'us-east-1' +AND data__Identifier = '<DistributionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/distributions/index.md b/docs/awscc-docs/providers/awscc/lightsail/distributions/index.md new file mode 100644 index 0000000000..9992d63b00 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/distributions/index.md @@ -0,0 +1,67 @@ +--- +title: distributions +hide_title: false +hide_table_of_contents: false +keywords: + - distributions + - 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 +--- +Retrieves a list of distributions in a region + +## Overview + + + + + +
Namedistributions
TypeResource
Descriptiondistributions
Idawscc.lightsail.distributions
+ +## Fields + + + + + +
NameDatatypeDescription
distribution_namestringThe name for the distribution.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the distributions resource, the following permissions are required: + +### Create +
+lightsail:AttachCertificateToDistribution,
+lightsail:CreateDistribution,
+lightsail:DetachCertificateFromDistribution,
+lightsail:GetCertificates,
+lightsail:GetCertificateDetails,
+lightsail:GetDistributions,
+lightsail:TagResource,
+lightsail:UntagResource,
+lightsail:UpdateDistribution,
+lightsail:UpdateDistributionBundle
+ +### List +
+lightsail:GetDistributions
+ + +## Example +```sql +SELECT +region, +distribution_name +FROM awscc.lightsail.distributions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/index.md b/docs/awscc-docs/providers/awscc/lightsail/index.md new file mode 100644 index 0000000000..954e446266 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/index.md @@ -0,0 +1,57 @@ +--- +title: lightsail +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The lightsail service documentation. + +:::info Service Summary + +
+
+total resources: 20
+total selectable resources: 20
+total methods: 20
+
+
+ +::: + +## Resources +
+
+alarm
+alarms
+bucket
+buckets
+certificate
+certificates
+container
+containers
+database
+databases +
+
+distribution
+distributions
+instance
+instances
+load_balancer
+load_balancer_tls_certificate
+load_balancer_tls_certificates
+load_balancers
+static_ip
+static_ips +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/lightsail/instance/index.md b/docs/awscc-docs/providers/awscc/lightsail/instance/index.md new file mode 100644 index 0000000000..f8f21a1374 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/instance/index.md @@ -0,0 +1,116 @@ +--- +title: instance +hide_title: false +hide_table_of_contents: false +keywords: + - instance + - 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 +--- +Gets an individual instance resource + +## Overview + + + + + +
Nameinstance
TypeResource
Descriptioninstance
Idawscc.lightsail.instance
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
support_codestringSupport code to help identify any issues
resource_typestringResource type of Lightsail instance.
is_static_ipbooleanIs the IP Address of the Instance is the static IP
private_ip_addressstringPrivate IP Address of the Instance
public_ip_addressstringPublic IP Address of the Instance
locationobject
hardwareobject
stateobject
networkingobject
user_namestringUsername of the Lightsail instance.
ssh_key_namestringSSH Key Name of the Lightsail instance.
instance_namestringThe names to use for your new Lightsail instance.
availability_zonestringThe 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.
bundle_idstringThe bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
blueprint_idstringThe 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 ).
add_onsarrayAn array of objects representing the add-ons to enable for the new instance.
user_datastringA launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
key_pair_namestringThe name of your key pair.
tagsarrayAn array of key-value pairs to apply to this resource.
instance_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance resource, the following permissions are required: + +### Read +
+lightsail:GetInstances,
+lightsail:GetInstance
+ +### Delete +
+lightsail:GetInstances,
+lightsail:GetInstance,
+lightsail:DeleteInstance
+ +### Update +
+lightsail:GetInstances,
+lightsail:GetInstance,
+lightsail:DeleteInstance,
+lightsail:EnableAddOn,
+lightsail:DisableAddOn,
+lightsail:PutInstancePublicPorts,
+lightsail:AttachDisk,
+lightsail:DetachDisk,
+lightsail:StartInstance,
+lightsail:StopInstance,
+lightsail:GetDisk,
+lightsail:TagResource,
+lightsail:UntagResource
+ + +## Example +```sql +SELECT +region, +support_code, +resource_type, +is_static_ip, +private_ip_address, +public_ip_address, +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 awscc.lightsail.instance +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/instances/index.md b/docs/awscc-docs/providers/awscc/lightsail/instances/index.md new file mode 100644 index 0000000000..c28c878d81 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/instances/index.md @@ -0,0 +1,71 @@ +--- +title: instances +hide_title: false +hide_table_of_contents: false +keywords: + - instances + - 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 +--- +Retrieves a list of instances in a region + +## Overview + + + + + +
Nameinstances
TypeResource
Descriptioninstances
Idawscc.lightsail.instances
+ +## Fields + + + + + +
NameDatatypeDescription
instance_namestringThe names to use for your new Lightsail instance.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instances resource, the following permissions are required: + +### Create +
+lightsail:CreateInstances,
+lightsail:GetInstances,
+lightsail:EnableAddOn,
+lightsail:GetInstance,
+lightsail:DisableAddOn,
+lightsail:PutInstancePublicPorts,
+lightsail:AttachDisk,
+lightsail:DetachDisk,
+lightsail:StartInstance,
+lightsail:StopInstance,
+lightsail:GetDisk,
+lightsail:GetRegions,
+lightsail:TagResource,
+lightsail:UntagResource
+ +### List +
+lightsail:GetInstances
+ + +## Example +```sql +SELECT +region, +instance_name +FROM awscc.lightsail.instances +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md b/docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md new file mode 100644 index 0000000000..66136ae94d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md @@ -0,0 +1,91 @@ +--- +title: load_balancer +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer + - 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 +--- +Gets an individual load_balancer resource + +## Overview + + + + + +
Nameload_balancer
TypeResource
Descriptionload_balancer
Idawscc.lightsail.load_balancer
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
load_balancer_arnstring
instance_portintegerThe instance port where you're creating your load balancer.
ip_address_typestringThe 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.
attached_instancesarrayThe names of the instances attached to the load balancer.
health_check_pathstringThe 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., "/").
session_stickiness_enabledbooleanConfiguration option to enable session stickiness.
session_stickiness_lb_cookie_duration_secondsstringConfiguration option to adjust session stickiness cookie duration parameter.
tls_policy_namestringThe name of the TLS policy to apply to the load balancer.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the load_balancer resource, the following permissions are required: + +### Read +
+lightsail:GetLoadBalancer,
+lightsail:GetLoadBalancers
+ +### Update +
+lightsail:GetLoadBalancer,
+lightsail:GetLoadBalancers,
+lightsail:GetInstance,
+lightsail:AttachInstancesToLoadBalancer,
+lightsail:DetachInstancesFromLoadBalancer,
+lightsail:UpdateLoadBalancerAttribute,
+lightsail:TagResource,
+lightsail:UntagResource
+ +### Delete +
+lightsail:DeleteLoadBalancer,
+lightsail:GetLoadBalancer,
+lightsail:GetLoadBalancers
+ + +## Example +```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, +tags +FROM awscc.lightsail.load_balancer +WHERE region = 'us-east-1' +AND data__Identifier = '<LoadBalancerName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificate/index.md b/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificate/index.md new file mode 100644 index 0000000000..166a91427b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificate/index.md @@ -0,0 +1,84 @@ +--- +title: load_balancer_tls_certificate +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tls_certificate + - 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 +--- +Gets an individual load_balancer_tls_certificate resource + +## Overview + + + + + +
Nameload_balancer_tls_certificate
TypeResource
Descriptionload_balancer_tls_certificate
Idawscc.lightsail.load_balancer_tls_certificate
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
certificate_namestringThe SSL/TLS certificate name.
certificate_domain_namestringThe domain name (e.g., example.com ) for your SSL/TLS certificate.
certificate_alternative_namesarrayAn array of strings listing alternative domains and subdomains for your SSL/TLS certificate.
load_balancer_tls_certificate_arnstring
is_attachedbooleanWhen true, the SSL/TLS certificate is attached to the Lightsail load balancer.
https_redirection_enabledbooleanA Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
statusstringThe validation status of the SSL/TLS certificate.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the load_balancer_tls_certificate resource, the following permissions are required: + +### Read +
+lightsail:GetLoadBalancerTlsCertificates,
+lightsail:GetLoadBalancer
+ +### Update +
+lightsail:AttachLoadBalancerTlsCertificate,
+lightsail:GetLoadBalancerTlsCertificates,
+lightsail:GetLoadBalancer,
+lightsail:UpdateLoadBalancerAttribute
+ +### Delete +
+lightsail:DeleteLoadBalancerTlsCertificate,
+lightsail:GetLoadBalancerTlsCertificates,
+lightsail:GetLoadBalancer
+ + +## Example +```sql +SELECT +region, +load_balancer_name, +certificate_name, +certificate_domain_name, +certificate_alternative_names, +load_balancer_tls_certificate_arn, +is_attached, +https_redirection_enabled, +status +FROM awscc.lightsail.load_balancer_tls_certificate +WHERE region = 'us-east-1' +AND data__Identifier = '<CertificateName>' +AND data__Identifier = '<LoadBalancerName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificates/index.md b/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificates/index.md new file mode 100644 index 0000000000..92a0225026 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificates/index.md @@ -0,0 +1,65 @@ +--- +title: load_balancer_tls_certificates +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tls_certificates + - 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 +--- +Retrieves a list of load_balancer_tls_certificates in a region + +## Overview + + + + + +
Nameload_balancer_tls_certificates
TypeResource
Descriptionload_balancer_tls_certificates
Idawscc.lightsail.load_balancer_tls_certificates
+ +## Fields + + + + + + +
NameDatatypeDescription
certificate_namestringThe SSL/TLS certificate name.
load_balancer_namestringThe name of your load balancer.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the load_balancer_tls_certificates resource, the following permissions are required: + +### Create +
+lightsail:CreateLoadBalancerTlsCertificate,
+lightsail:GetLoadBalancerTlsCertificates,
+lightsail:GetLoadBalancer,
+lightsail:AttachLoadBalancerTlsCertificate,
+lightsail:UpdateLoadBalancerAttribute
+ +### List +
+lightsail:GetLoadBalancerTlsCertificates,
+lightsail:GetLoadBalancer
+ + +## Example +```sql +SELECT +region, +certificate_name, +load_balancer_name +FROM awscc.lightsail.load_balancer_tls_certificates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md b/docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md new file mode 100644 index 0000000000..00d5b858a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md @@ -0,0 +1,66 @@ +--- +title: load_balancers +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancers + - 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 +--- +Retrieves a list of load_balancers in a region + +## Overview + + + + + +
Nameload_balancers
TypeResource
Descriptionload_balancers
Idawscc.lightsail.load_balancers
+ +## Fields + + + + + +
NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the load_balancers resource, the following permissions are required: + +### Create +
+lightsail:CreateLoadBalancer,
+lightsail:GetLoadBalancer,
+lightsail:GetLoadBalancers,
+lightsail:GetInstance,
+lightsail:AttachInstancesToLoadBalancer,
+lightsail:DetachInstancesFromLoadBalancer,
+lightsail:UpdateLoadBalancerAttribute,
+lightsail:TagResource,
+lightsail:UntagResource
+ +### List +
+lightsail:GetLoadBalancers
+ + +## Example +```sql +SELECT +region, +load_balancer_name +FROM awscc.lightsail.load_balancers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md b/docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md new file mode 100644 index 0000000000..967344feb9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md @@ -0,0 +1,78 @@ +--- +title: static_ip +hide_title: false +hide_table_of_contents: false +keywords: + - static_ip + - 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 +--- +Gets an individual static_ip resource + +## Overview + + + + + +
Namestatic_ip
TypeResource
Descriptionstatic_ip
Idawscc.lightsail.static_ip
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
static_ip_namestringThe name of the static IP address.
attached_tostringThe instance where the static IP is attached.
is_attachedbooleanA Boolean value indicating whether the static IP is attached.
ip_addressstringThe static IP address.
static_ip_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the static_ip resource, the following permissions are required: + +### Read +
+lightsail:GetStaticIp,
+lightsail:GetStaticIps
+ +### Update +
+lightsail:AttachStaticIp,
+lightsail:DetachStaticIp,
+lightsail:GetInstance,
+lightsail:GetStaticIp,
+lightsail:GetStaticIps
+ +### Delete +
+lightsail:GetStaticIp,
+lightsail:GetStaticIps,
+lightsail:ReleaseStaticIp
+ + +## Example +```sql +SELECT +region, +static_ip_name, +attached_to, +is_attached, +ip_address, +static_ip_arn +FROM awscc.lightsail.static_ip +WHERE region = 'us-east-1' +AND data__Identifier = '<StaticIpName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md b/docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md new file mode 100644 index 0000000000..2a41843901 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md @@ -0,0 +1,63 @@ +--- +title: static_ips +hide_title: false +hide_table_of_contents: false +keywords: + - static_ips + - 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 +--- +Retrieves a list of static_ips in a region + +## Overview + + + + + +
Namestatic_ips
TypeResource
Descriptionstatic_ips
Idawscc.lightsail.static_ips
+ +## Fields + + + + + +
NameDatatypeDescription
static_ip_namestringThe name of the static IP address.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the static_ips resource, the following permissions are required: + +### Create +
+lightsail:AllocateStaticIp,
+lightsail:AttachStaticIp,
+lightsail:DetachStaticIp,
+lightsail:GetInstance,
+lightsail:GetStaticIp,
+lightsail:GetStaticIps
+ +### List +
+lightsail:GetStaticIps
+ + +## Example +```sql +SELECT +region, +static_ip_name +FROM awscc.lightsail.static_ips +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/location/api_key/index.md b/docs/awscc-docs/providers/awscc/location/api_key/index.md new file mode 100644 index 0000000000..c08d42085b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/api_key/index.md @@ -0,0 +1,100 @@ +--- +title: api_key +hide_title: false +hide_table_of_contents: false +keywords: + - api_key + - 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 +--- +Gets an individual api_key resource + +## Overview + + + + + +
Nameapi_key
TypeResource
Descriptionapi_key
Idawscc.location.api_key
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
create_timestring
descriptionstring
expire_timestring
force_updateboolean
key_arnstring
key_namestring
no_expiryboolean
restrictionsobject
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
force_deleteboolean
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_key resource, the following permissions are required: + +### Read +
+geo:DescribeKey
+ +### Update +
+geo:CreateKey,
+geo:DescribeKey,
+geo:TagResource,
+geo:UntagResource,
+geo:GetMapTile,
+geo:GetMapStyleDescriptor,
+geo:GetMapSprites,
+geo:GetMapGlyphs,
+geo:SearchPlaceIndexForText,
+geo:SearchPlaceIndexForPosition,
+geo:SearchPlaceIndexForSuggestions,
+geo:GetPlace,
+geo:CalculateRoute,
+geo:CalculateRouteMatrix,
+geo:UpdateKey
+ +### Delete +
+geo:DeleteKey,
+geo:DescribeKey
+ + +## Example +```sql +SELECT +region, +create_time, +description, +expire_time, +force_update, +key_arn, +key_name, +no_expiry, +restrictions, +tags, +update_time, +force_delete, +arn +FROM awscc.location.api_key +WHERE region = 'us-east-1' +AND data__Identifier = '<KeyName>' +``` diff --git a/docs/awscc-docs/providers/awscc/location/api_keys/index.md b/docs/awscc-docs/providers/awscc/location/api_keys/index.md new file mode 100644 index 0000000000..bdcfee6f5f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/api_keys/index.md @@ -0,0 +1,71 @@ +--- +title: api_keys +hide_title: false +hide_table_of_contents: false +keywords: + - api_keys + - 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 +--- +Retrieves a list of api_keys in a region + +## Overview + + + + + +
Nameapi_keys
TypeResource
Descriptionapi_keys
Idawscc.location.api_keys
+ +## Fields + + + + + +
NameDatatypeDescription
key_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the api_keys resource, the following permissions are required: + +### Create +
+geo:CreateKey,
+geo:DescribeKey,
+geo:TagResource,
+geo:UntagResource,
+geo:GetMapTile,
+geo:GetMapStyleDescriptor,
+geo:GetMapSprites,
+geo:GetMapGlyphs,
+geo:SearchPlaceIndexForText,
+geo:SearchPlaceIndexForPosition,
+geo:SearchPlaceIndexForSuggestions,
+geo:GetPlace,
+geo:CalculateRoute,
+geo:CalculateRouteMatrix
+ +### List +
+geo:ListKeys
+ + +## Example +```sql +SELECT +region, +key_name +FROM awscc.location.api_keys +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/location/geofence_collection/index.md b/docs/awscc-docs/providers/awscc/location/geofence_collection/index.md new file mode 100644 index 0000000000..4b0dc94abf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/geofence_collection/index.md @@ -0,0 +1,89 @@ +--- +title: geofence_collection +hide_title: false +hide_table_of_contents: false +keywords: + - geofence_collection + - 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 +--- +Gets an individual geofence_collection resource + +## Overview + + + + + +
Namegeofence_collection
TypeResource
Descriptiongeofence_collection
Idawscc.location.geofence_collection
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
collection_arnstring
collection_namestring
create_timestring
descriptionstring
kms_key_idstring
pricing_planstring
pricing_plan_data_sourcestring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the geofence_collection resource, the following permissions are required: + +### Read +
+geo:DescribeGeofenceCollection,
+kms:DescribeKey
+ +### Update +
+geo:CreateGeofenceCollection,
+geo:DescribeGeofenceCollection,
+geo:TagResource,
+geo:UntagResource,
+kms:DescribeKey,
+kms:CreateGrant,
+geo:UpdateGeofenceCollection
+ +### Delete +
+geo:DeleteGeofenceCollection,
+geo:DescribeGeofenceCollection
+ + +## Example +```sql +SELECT +region, +collection_arn, +collection_name, +create_time, +description, +kms_key_id, +pricing_plan, +pricing_plan_data_source, +tags, +update_time, +arn +FROM awscc.location.geofence_collection +WHERE region = 'us-east-1' +AND data__Identifier = '<CollectionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/location/geofence_collections/index.md b/docs/awscc-docs/providers/awscc/location/geofence_collections/index.md new file mode 100644 index 0000000000..d5df82e5ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/geofence_collections/index.md @@ -0,0 +1,63 @@ +--- +title: geofence_collections +hide_title: false +hide_table_of_contents: false +keywords: + - geofence_collections + - 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 +--- +Retrieves a list of geofence_collections in a region + +## Overview + + + + + +
Namegeofence_collections
TypeResource
Descriptiongeofence_collections
Idawscc.location.geofence_collections
+ +## Fields + + + + + +
NameDatatypeDescription
collection_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the geofence_collections resource, the following permissions are required: + +### Create +
+geo:CreateGeofenceCollection,
+geo:DescribeGeofenceCollection,
+geo:TagResource,
+geo:UntagResource,
+kms:DescribeKey,
+kms:CreateGrant
+ +### List +
+geo:ListGeofenceCollections
+ + +## Example +```sql +SELECT +region, +collection_name +FROM awscc.location.geofence_collections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/location/index.md b/docs/awscc-docs/providers/awscc/location/index.md new file mode 100644 index 0000000000..3e7438f12a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/index.md @@ -0,0 +1,51 @@ +--- +title: location +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The location service documentation. + +:::info Service Summary + +
+
+total resources: 14
+total selectable resources: 14
+total methods: 14
+
+
+ +::: + +## Resources +
+
+api_key
+api_keys
+geofence_collection
+geofence_collections
+map
+maps
+place_index +
+
+place_indices
+route_calculator
+route_calculators
+tracker
+tracker_consumer
+tracker_consumers
+trackers +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/location/map/index.md b/docs/awscc-docs/providers/awscc/location/map/index.md new file mode 100644 index 0000000000..7465c129b1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/map/index.md @@ -0,0 +1,84 @@ +--- +title: map +hide_title: false +hide_table_of_contents: false +keywords: + - map + - 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 +--- +Gets an individual map resource + +## Overview + + + + + +
Namemap
TypeResource
Descriptionmap
Idawscc.location.map
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
configurationobject
create_timestring
descriptionstring
map_arnstring
map_namestring
pricing_planstring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the map resource, the following permissions are required: + +### Read +
+geo:DescribeMap
+ +### Update +
+geo:CreateMap,
+geo:DescribeMap,
+geo:TagResource,
+geo:UntagResource,
+geo:UpdateMap
+ +### Delete +
+geo:DeleteMap,
+geo:DescribeMap
+ + +## Example +```sql +SELECT +region, +configuration, +create_time, +description, +map_arn, +map_name, +pricing_plan, +tags, +update_time, +arn +FROM awscc.location.map +WHERE region = 'us-east-1' +AND data__Identifier = '<MapName>' +``` diff --git a/docs/awscc-docs/providers/awscc/location/maps/index.md b/docs/awscc-docs/providers/awscc/location/maps/index.md new file mode 100644 index 0000000000..224e5501f0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/maps/index.md @@ -0,0 +1,61 @@ +--- +title: maps +hide_title: false +hide_table_of_contents: false +keywords: + - maps + - 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 +--- +Retrieves a list of maps in a region + +## Overview + + + + + +
Namemaps
TypeResource
Descriptionmaps
Idawscc.location.maps
+ +## Fields + + + + + +
NameDatatypeDescription
map_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the maps resource, the following permissions are required: + +### Create +
+geo:CreateMap,
+geo:DescribeMap,
+geo:TagResource,
+geo:UntagResource
+ +### List +
+geo:ListMaps
+ + +## Example +```sql +SELECT +region, +map_name +FROM awscc.location.maps +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/location/place_index/index.md b/docs/awscc-docs/providers/awscc/location/place_index/index.md new file mode 100644 index 0000000000..427575f6de --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/place_index/index.md @@ -0,0 +1,86 @@ +--- +title: place_index +hide_title: false +hide_table_of_contents: false +keywords: + - place_index + - 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 +--- +Gets an individual place_index resource + +## Overview + + + + + +
Nameplace_index
TypeResource
Descriptionplace_index
Idawscc.location.place_index
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
create_timestring
data_sourcestring
data_source_configurationobject
descriptionstring
index_arnstring
index_namestring
pricing_planstring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the place_index resource, the following permissions are required: + +### Read +
+geo:DescribePlaceIndex
+ +### Update +
+geo:CreatePlaceIndex,
+geo:DescribePlaceIndex,
+geo:TagResource,
+geo:UntagResource,
+geo:UpdatePlaceIndex
+ +### Delete +
+geo:DeletePlaceIndex,
+geo:DescribePlaceIndex
+ + +## Example +```sql +SELECT +region, +create_time, +data_source, +data_source_configuration, +description, +index_arn, +index_name, +pricing_plan, +tags, +update_time, +arn +FROM awscc.location.place_index +WHERE region = 'us-east-1' +AND data__Identifier = '<IndexName>' +``` diff --git a/docs/awscc-docs/providers/awscc/location/place_indices/index.md b/docs/awscc-docs/providers/awscc/location/place_indices/index.md new file mode 100644 index 0000000000..dc25e04397 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/place_indices/index.md @@ -0,0 +1,61 @@ +--- +title: place_indices +hide_title: false +hide_table_of_contents: false +keywords: + - place_indices + - 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 +--- +Retrieves a list of place_indices in a region + +## Overview + + + + + +
Nameplace_indices
TypeResource
Descriptionplace_indices
Idawscc.location.place_indices
+ +## Fields + + + + + +
NameDatatypeDescription
index_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the place_indices resource, the following permissions are required: + +### Create +
+geo:CreatePlaceIndex,
+geo:DescribePlaceIndex,
+geo:TagResource,
+geo:UntagResource
+ +### List +
+geo:ListPlaceIndexes
+ + +## Example +```sql +SELECT +region, +index_name +FROM awscc.location.place_indices +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/location/route_calculator/index.md b/docs/awscc-docs/providers/awscc/location/route_calculator/index.md new file mode 100644 index 0000000000..76f8a42496 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/route_calculator/index.md @@ -0,0 +1,84 @@ +--- +title: route_calculator +hide_title: false +hide_table_of_contents: false +keywords: + - route_calculator + - 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 +--- +Gets an individual route_calculator resource + +## Overview + + + + + +
Nameroute_calculator
TypeResource
Descriptionroute_calculator
Idawscc.location.route_calculator
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
calculator_arnstring
calculator_namestring
create_timestring
data_sourcestring
descriptionstring
pricing_planstring
tagsarrayAn array of key-value pairs to apply to this resource.
update_timestring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the route_calculator resource, the following permissions are required: + +### Read +
+geo:DescribeRouteCalculator
+ +### Update +
+geo:CreateRouteCalculator,
+geo:DescribeRouteCalculator,
+geo:TagResource,
+geo:UntagResource,
+geo:UpdateRouteCalculator
+ +### Delete +
+geo:DeleteRouteCalculator,
+geo:DescribeRouteCalculator
+ + +## Example +```sql +SELECT +region, +calculator_arn, +calculator_name, +create_time, +data_source, +description, +pricing_plan, +tags, +update_time, +arn +FROM awscc.location.route_calculator +WHERE region = 'us-east-1' +AND data__Identifier = '<CalculatorName>' +``` diff --git a/docs/awscc-docs/providers/awscc/location/route_calculators/index.md b/docs/awscc-docs/providers/awscc/location/route_calculators/index.md new file mode 100644 index 0000000000..bb52be7154 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/route_calculators/index.md @@ -0,0 +1,61 @@ +--- +title: route_calculators +hide_title: false +hide_table_of_contents: false +keywords: + - route_calculators + - 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 +--- +Retrieves a list of route_calculators in a region + +## Overview + + + + + +
Nameroute_calculators
TypeResource
Descriptionroute_calculators
Idawscc.location.route_calculators
+ +## Fields + + + + + +
NameDatatypeDescription
calculator_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the route_calculators resource, the following permissions are required: + +### Create +
+geo:CreateRouteCalculator,
+geo:DescribeRouteCalculator,
+geo:TagResource,
+geo:UntagResource
+ +### List +
+geo:ListRouteCalculators
+ + +## Example +```sql +SELECT +region, +calculator_name +FROM awscc.location.route_calculators +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/location/tracker/index.md b/docs/awscc-docs/providers/awscc/location/tracker/index.md new file mode 100644 index 0000000000..421846b487 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/tracker/index.md @@ -0,0 +1,95 @@ +--- +title: tracker +hide_title: false +hide_table_of_contents: false +keywords: + - tracker + - 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 +--- +Gets an individual tracker resource + +## Overview + + + + + +
Nametracker
TypeResource
Descriptiontracker
Idawscc.location.tracker
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
create_timestring
descriptionstring
event_bridge_enabledboolean
kms_key_enable_geospatial_queriesboolean
kms_key_idstring
position_filteringstring
pricing_planstring
pricing_plan_data_sourcestring
tagsarrayAn array of key-value pairs to apply to this resource.
tracker_arnstring
tracker_namestring
update_timestring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tracker resource, the following permissions are required: + +### Read +
+geo:DescribeTracker,
+kms:DescribeKey
+ +### Update +
+geo:CreateTracker,
+geo:DescribeTracker,
+geo:TagResource,
+geo:UntagResource,
+kms:DescribeKey,
+kms:CreateGrant,
+geo:UpdateTracker
+ +### Delete +
+geo:DeleteTracker,
+geo:DescribeTracker
+ + +## Example +```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, +tags, +tracker_arn, +tracker_name, +update_time, +arn +FROM awscc.location.tracker +WHERE region = 'us-east-1' +AND data__Identifier = '<TrackerName>' +``` diff --git a/docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md b/docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md new file mode 100644 index 0000000000..8cc8859bdf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md @@ -0,0 +1,63 @@ +--- +title: tracker_consumer +hide_title: false +hide_table_of_contents: false +keywords: + - tracker_consumer + - 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 +--- +Gets an individual tracker_consumer resource + +## Overview + + + + + +
Nametracker_consumer
TypeResource
Descriptiontracker_consumer
Idawscc.location.tracker_consumer
+ +## Fields + + + + + + +
NameDatatypeDescription
consumer_arnstring
tracker_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tracker_consumer resource, the following permissions are required: + +### Delete +
+geo:DisassociateTrackerConsumer,
+geo:ListTrackerConsumers
+ +### Read +
+geo:ListTrackerConsumers
+ + +## Example +```sql +SELECT +region, +consumer_arn, +tracker_name +FROM awscc.location.tracker_consumer +WHERE region = 'us-east-1' +AND data__Identifier = '<TrackerName>' +AND data__Identifier = '<ConsumerArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md b/docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md new file mode 100644 index 0000000000..20829a8a64 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md @@ -0,0 +1,61 @@ +--- +title: tracker_consumers +hide_title: false +hide_table_of_contents: false +keywords: + - tracker_consumers + - 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 +--- +Retrieves a list of tracker_consumers in a region + +## Overview + + + + + +
Nametracker_consumers
TypeResource
Descriptiontracker_consumers
Idawscc.location.tracker_consumers
+ +## Fields + + + + + + +
NameDatatypeDescription
tracker_namestring
consumer_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tracker_consumers resource, the following permissions are required: + +### Create +
+geo:AssociateTrackerConsumer,
+geo:ListTrackerConsumers
+ +### List +
+geo:ListTrackerConsumers
+ + +## Example +```sql +SELECT +region, +tracker_name, +consumer_arn +FROM awscc.location.tracker_consumers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/location/trackers/index.md b/docs/awscc-docs/providers/awscc/location/trackers/index.md new file mode 100644 index 0000000000..bfb679d21e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/location/trackers/index.md @@ -0,0 +1,63 @@ +--- +title: trackers +hide_title: false +hide_table_of_contents: false +keywords: + - trackers + - 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 +--- +Retrieves a list of trackers in a region + +## Overview + + + + + +
Nametrackers
TypeResource
Descriptiontrackers
Idawscc.location.trackers
+ +## Fields + + + + + +
NameDatatypeDescription
tracker_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trackers resource, the following permissions are required: + +### Create +
+geo:CreateTracker,
+geo:DescribeTracker,
+geo:TagResource,
+geo:UntagResource,
+kms:DescribeKey,
+kms:CreateGrant
+ +### List +
+geo:ListTrackers
+ + +## Example +```sql +SELECT +region, +tracker_name +FROM awscc.location.trackers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/account_policies/index.md b/docs/awscc-docs/providers/awscc/logs/account_policies/index.md new file mode 100644 index 0000000000..757cbbed48 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/account_policies/index.md @@ -0,0 +1,70 @@ +--- +title: account_policies +hide_title: false +hide_table_of_contents: false +keywords: + - account_policies + - 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 +--- +Retrieves a list of account_policies in a region + +## Overview + + + + + +
Nameaccount_policies
TypeResource
Descriptionaccount_policies
Idawscc.logs.account_policies
+ +## Fields + + + + + + + +
NameDatatypeDescription
account_idstringUser account id
policy_typestringType of the policy.
policy_namestringThe name of the account policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account_policies resource, the following permissions are required: + +### Create +
+logs:PutAccountPolicy,
+logs:PutDataProtectionPolicy,
+logs:DescribeAccountPolicies,
+logs:CreateLogDelivery,
+s3:REST.PUT.OBJECT,
+firehose:TagDeliveryStream,
+logs:PutSubscriptionFilter,
+logs:DeleteSubscriptionFilter,
+iam:PassRole
+ +### List +
+logs:DescribeAccountPolicies
+ + +## Example +```sql +SELECT +region, +account_id, +policy_type, +policy_name +FROM awscc.logs.account_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/account_policy/index.md b/docs/awscc-docs/providers/awscc/logs/account_policy/index.md new file mode 100644 index 0000000000..c984e9fdee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/account_policy/index.md @@ -0,0 +1,89 @@ +--- +title: account_policy +hide_title: false +hide_table_of_contents: false +keywords: + - account_policy + - 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 +--- +Gets an individual account_policy resource + +## Overview + + + + + +
Nameaccount_policy
TypeResource
Descriptionaccount_policy
Idawscc.logs.account_policy
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
account_idstringUser account id
policy_namestringThe name of the account policy
policy_documentstringThe body of the policy document you want to use for this topic.<br/><br/>You can only add one policy per PolicyType.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 30720
policy_typestringType of the policy.
scopestringScope for policy application
selection_criteriastringLog 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
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account_policy resource, the following permissions are required: + +### Read +
+logs:DescribeAccountPolicies
+ +### Update +
+logs:PutAccountPolicy,
+logs:PutDataProtectionPolicy,
+logs:DescribeAccountPolicies,
+logs:DeleteAccountPolicy,
+logs:DeleteDataProtectionPolicy,
+logs:CreateLogDelivery,
+logs:PutSubscriptionFilter,
+logs:DeleteSubscriptionFilter,
+s3:REST.PUT.OBJECT,
+firehose:TagDeliveryStream,
+iam:PassRole
+ +### Delete +
+logs:DeleteAccountPolicy,
+logs:DeleteDataProtectionPolicy,
+logs:DescribeAccountPolicies,
+logs:DeleteSubscriptionFilter,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +account_id, +policy_name, +policy_document, +policy_type, +scope, +selection_criteria +FROM awscc.logs.account_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountId>' +AND data__Identifier = '<PolicyType>' +AND data__Identifier = '<PolicyName>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/deliveries/index.md b/docs/awscc-docs/providers/awscc/logs/deliveries/index.md new file mode 100644 index 0000000000..16d9eb527d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/deliveries/index.md @@ -0,0 +1,65 @@ +--- +title: deliveries +hide_title: false +hide_table_of_contents: false +keywords: + - deliveries + - 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 +--- +Retrieves a list of deliveries in a region + +## Overview + + + + + +
Namedeliveries
TypeResource
Descriptiondeliveries
Idawscc.logs.deliveries
+ +## Fields + + + + + +
NameDatatypeDescription
delivery_idstringThe unique ID that identifies this delivery in your account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the deliveries resource, the following permissions are required: + +### Create +
+logs:CreateDelivery,
+logs:GetDelivery,
+logs:DescribeDeliveries,
+logs:ListTagsForResource,
+logs:TagResource,
+logs:GetDeliverySource,
+logs:GetDeliveryDestination
+ +### List +
+logs:DescribeDeliveries,
+logs:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +delivery_id +FROM awscc.logs.deliveries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/delivery/index.md b/docs/awscc-docs/providers/awscc/logs/delivery/index.md new file mode 100644 index 0000000000..f47c0d78ea --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/delivery/index.md @@ -0,0 +1,79 @@ +--- +title: delivery +hide_title: false +hide_table_of_contents: false +keywords: + - delivery + - 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 +--- +Gets an individual delivery resource + +## Overview + + + + + +
Namedelivery
TypeResource
Descriptiondelivery
Idawscc.logs.delivery
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
delivery_idstringThe unique ID that identifies this delivery in your account.
arnstringThe Amazon Resource Name (ARN) that uniquely identifies this delivery.
delivery_source_namestringThe name of the delivery source that is associated with this delivery.
delivery_destination_arnstringThe ARN of the delivery destination that is associated with this delivery.
delivery_destination_typestringDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
tagsarrayThe tags that have been assigned to this delivery.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the delivery resource, the following permissions are required: + +### Read +
+logs:GetDelivery,
+logs:ListTagsForResource
+ +### Update +
+logs:GetDelivery,
+logs:ListTagsForResource,
+logs:TagResource,
+logs:UntagResource
+ +### Delete +
+logs:DeleteDelivery,
+logs:ListTagsForResource,
+logs:UntagResource
+ + +## Example +```sql +SELECT +region, +delivery_id, +arn, +delivery_source_name, +delivery_destination_arn, +delivery_destination_type, +tags +FROM awscc.logs.delivery +WHERE region = 'us-east-1' +AND data__Identifier = '<DeliveryId>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md new file mode 100644 index 0000000000..f0dbd3841b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md @@ -0,0 +1,83 @@ +--- +title: delivery_destination +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_destination + - 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 +--- +Gets an individual delivery_destination resource + +## Overview + + + + + +
Namedelivery_destination
TypeResource
Descriptiondelivery_destination
Idawscc.logs.delivery_destination
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of this delivery destination.
arnstringThe Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
destination_resource_arnstringThe ARN of the AWS resource that will receive the logs.
tagsarrayThe tags that have been assigned to this delivery destination.
delivery_destination_typestringDisplays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
delivery_destination_policyobjectIAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 51200
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the delivery_destination resource, the following permissions are required: + +### Read +
+logs:GetDeliveryDestination,
+logs:ListTagsForResource,
+logs:GetDeliveryDestinationPolicy
+ +### Update +
+logs:PutDeliveryDestination,
+logs:GetDeliveryDestination,
+logs:ListTagsForResource,
+logs:TagResource,
+logs:UntagResource,
+logs:DeleteDeliveryDestinationPolicy,
+logs:PutDeliveryDestinationPolicy,
+logs:GetDeliveryDestinationPolicy
+ +### Delete +
+logs:DeleteDeliveryDestination,
+logs:DeleteDeliveryDestinationPolicy
+ + +## Example +```sql +SELECT +region, +name, +arn, +destination_resource_arn, +tags, +delivery_destination_type, +delivery_destination_policy +FROM awscc.logs.delivery_destination +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md new file mode 100644 index 0000000000..f20d831a04 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md @@ -0,0 +1,65 @@ +--- +title: delivery_destinations +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_destinations + - 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 +--- +Retrieves a list of delivery_destinations in a region + +## Overview + + + + + +
Namedelivery_destinations
TypeResource
Descriptiondelivery_destinations
Idawscc.logs.delivery_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of this delivery destination.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the delivery_destinations resource, the following permissions are required: + +### Create +
+logs:PutDeliveryDestination,
+logs:GetDeliveryDestination,
+logs:ListTagsForResource,
+logs:TagResource,
+logs:UntagResource,
+logs:PutDeliveryDestinationPolicy,
+logs:GetDeliveryDestinationPolicy
+ +### List +
+logs:DescribeDeliveryDestinations,
+logs:GetDeliveryDestinationPolicy
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.logs.delivery_destinations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_source/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_source/index.md new file mode 100644 index 0000000000..fbf973d6d7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/delivery_source/index.md @@ -0,0 +1,80 @@ +--- +title: delivery_source +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_source + - 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 +--- +Gets an individual delivery_source resource + +## Overview + + + + + +
Namedelivery_source
TypeResource
Descriptiondelivery_source
Idawscc.logs.delivery_source
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringThe unique name of the Log source.
arnstringThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.
resource_arnsarrayThis 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.
resource_arnstringThe ARN of the resource that will be sending the logs.
servicestringThe AWS service that is sending logs.
log_typestringThe 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.
tagsarrayThe tags that have been assigned to this delivery source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the delivery_source resource, the following permissions are required: + +### Read +
+logs:GetDeliverySource,
+logs:ListTagsForResource
+ +### Update +
+logs:PutDeliverySource,
+logs:GetDeliverySource,
+logs:ListTagsForResource,
+logs:TagResource,
+logs:UntagResource
+ +### Delete +
+logs:DeleteDeliverySource
+ + +## Example +```sql +SELECT +region, +name, +arn, +resource_arns, +resource_arn, +service, +log_type, +tags +FROM awscc.logs.delivery_source +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md new file mode 100644 index 0000000000..e6e69b96e4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md @@ -0,0 +1,65 @@ +--- +title: delivery_sources +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_sources + - 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 +--- +Retrieves a list of delivery_sources in a region + +## Overview + + + + + +
Namedelivery_sources
TypeResource
Descriptiondelivery_sources
Idawscc.logs.delivery_sources
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe unique name of the Log source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the delivery_sources resource, the following permissions are required: + +### Create +
+logs:PutDeliverySource,
+logs:GetDeliverySource,
+logs:ListTagsForResource,
+logs:TagResource,
+logs:AllowVendedLogDeliveryForResource,
+codewhisperer:AllowVendedLogDeliveryForResource,
+autoloop:AllowVendedLogDeliveryForResource,
+workmail:AllowVendedLogDeliveryForResource
+ +### List +
+logs:DescribeDeliverySources
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.logs.delivery_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/destination/index.md b/docs/awscc-docs/providers/awscc/logs/destination/index.md new file mode 100644 index 0000000000..4940535600 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/destination/index.md @@ -0,0 +1,74 @@ +--- +title: destination +hide_title: false +hide_table_of_contents: false +keywords: + - destination + - 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 +--- +Gets an individual destination resource + +## Overview + + + + + +
Namedestination
TypeResource
Descriptiondestination
Idawscc.logs.destination
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
destination_namestringThe name of the destination resource
destination_policystringAn IAM policy document that governs which AWS accounts can create subscription filters against this destination.
role_arnstringThe ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource
target_arnstringThe ARN of the physical target where the log events are delivered (for example, a Kinesis stream)
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the destination resource, the following permissions are required: + +### Read +
+logs:DescribeDestinations
+ +### Update +
+logs:PutDestination,
+logs:PutDestinationPolicy,
+logs:DescribeDestinations,
+iam:PassRole
+ +### Delete +
+logs:DeleteDestination
+ + +## Example +```sql +SELECT +region, +arn, +destination_name, +destination_policy, +role_arn, +target_arn +FROM awscc.logs.destination +WHERE region = 'us-east-1' +AND data__Identifier = '<DestinationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/destinations/index.md b/docs/awscc-docs/providers/awscc/logs/destinations/index.md new file mode 100644 index 0000000000..641da6776d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/destinations/index.md @@ -0,0 +1,61 @@ +--- +title: destinations +hide_title: false +hide_table_of_contents: false +keywords: + - destinations + - 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 +--- +Retrieves a list of destinations in a region + +## Overview + + + + + +
Namedestinations
TypeResource
Descriptiondestinations
Idawscc.logs.destinations
+ +## Fields + + + + + +
NameDatatypeDescription
destination_namestringThe name of the destination resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the destinations resource, the following permissions are required: + +### Create +
+logs:PutDestination,
+logs:PutDestinationPolicy,
+logs:DescribeDestinations,
+iam:PassRole
+ +### List +
+logs:DescribeDestinations
+ + +## Example +```sql +SELECT +region, +destination_name +FROM awscc.logs.destinations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/index.md b/docs/awscc-docs/providers/awscc/logs/index.md new file mode 100644 index 0000000000..7f3c0a5fc6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/index.md @@ -0,0 +1,59 @@ +--- +title: logs +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The logs service documentation. + +:::info Service Summary + +
+
+total resources: 22
+total selectable resources: 22
+total methods: 22
+
+
+ +::: + +## Resources +
+
+account_policies
+account_policy
+deliveries
+delivery
+delivery_destination
+delivery_destinations
+delivery_source
+delivery_sources
+destination
+destinations
+log_anomaly_detector +
+
+log_anomaly_detectors
+log_stream
+log_streams
+metric_filter
+metric_filters
+query_definition
+query_definitions
+resource_policies
+resource_policy
+subscription_filter
+subscription_filters +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/logs/log_anomaly_detector/index.md b/docs/awscc-docs/providers/awscc/logs/log_anomaly_detector/index.md new file mode 100644 index 0000000000..b7875170bc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/log_anomaly_detector/index.md @@ -0,0 +1,83 @@ +--- +title: log_anomaly_detector +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detector + - 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 +--- +Gets an individual log_anomaly_detector resource + +## Overview + + + + + +
Namelog_anomaly_detector
TypeResource
Descriptionlog_anomaly_detector
Idawscc.logs.log_anomaly_detector
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
account_idstringAccount ID for owner of detector
kms_key_idstringThe Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
detector_namestringName of detector
log_group_arn_listarrayList of Arns for the given log group
evaluation_frequencystringHow often log group is evaluated
filter_patternstring
anomaly_detector_statusstringCurrent status of detector.
anomaly_visibility_timenumber
creation_time_stampnumberWhen detector was created.
last_modified_time_stampnumberWhen detector was lsat modified.
anomaly_detector_arnstringARN of LogAnomalyDetector
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_anomaly_detector resource, the following permissions are required: + +### Read +
+logs:GetLogAnomalyDetector
+ +### Update +
+logs:UpdateLogAnomalyDetector
+ +### Delete +
+logs:DeleteLogAnomalyDetector
+ + +## Example +```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 awscc.logs.log_anomaly_detector +WHERE region = 'us-east-1' +AND data__Identifier = '<AnomalyDetectorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/log_anomaly_detectors/index.md b/docs/awscc-docs/providers/awscc/logs/log_anomaly_detectors/index.md new file mode 100644 index 0000000000..efa135fd5f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/log_anomaly_detectors/index.md @@ -0,0 +1,58 @@ +--- +title: log_anomaly_detectors +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detectors + - 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 +--- +Retrieves a list of log_anomaly_detectors in a region + +## Overview + + + + + +
Namelog_anomaly_detectors
TypeResource
Descriptionlog_anomaly_detectors
Idawscc.logs.log_anomaly_detectors
+ +## Fields + + + + + +
NameDatatypeDescription
anomaly_detector_arnstringARN of LogAnomalyDetector
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_anomaly_detectors resource, the following permissions are required: + +### Create +
+logs:CreateLogAnomalyDetector
+ +### List +
+logs:ListLogAnomalyDetectors
+ + +## Example +```sql +SELECT +region, +anomaly_detector_arn +FROM awscc.logs.log_anomaly_detectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/log_stream/index.md b/docs/awscc-docs/providers/awscc/logs/log_stream/index.md new file mode 100644 index 0000000000..9536e0a186 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/log_stream/index.md @@ -0,0 +1,62 @@ +--- +title: log_stream +hide_title: false +hide_table_of_contents: false +keywords: + - log_stream + - 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 +--- +Gets an individual log_stream resource + +## Overview + + + + + +
Namelog_stream
TypeResource
Descriptionlog_stream
Idawscc.logs.log_stream
+ +## Fields + + + + + + +
NameDatatypeDescription
log_group_namestringThe name of the log group where the log stream is created.
log_stream_namestringThe name of the log stream. The name must be unique wihtin the log group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_stream resource, the following permissions are required: + +### Read +
+logs:DescribeLogStreams
+ +### Delete +
+logs:DeleteLogStream
+ + +## Example +```sql +SELECT +region, +log_group_name, +log_stream_name +FROM awscc.logs.log_stream +WHERE region = 'us-east-1' +AND data__Identifier = '<LogGroupName>' +AND data__Identifier = '<LogStreamName>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/log_streams/index.md b/docs/awscc-docs/providers/awscc/logs/log_streams/index.md new file mode 100644 index 0000000000..99f0137b37 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/log_streams/index.md @@ -0,0 +1,60 @@ +--- +title: log_streams +hide_title: false +hide_table_of_contents: false +keywords: + - log_streams + - 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 +--- +Retrieves a list of log_streams in a region + +## Overview + + + + + +
Namelog_streams
TypeResource
Descriptionlog_streams
Idawscc.logs.log_streams
+ +## Fields + + + + + + +
NameDatatypeDescription
log_group_namestringThe name of the log group where the log stream is created.
log_stream_namestringThe name of the log stream. The name must be unique wihtin the log group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the log_streams resource, the following permissions are required: + +### Create +
+logs:CreateLogStream
+ +### List +
+logs:DescribeLogStreams
+ + +## Example +```sql +SELECT +region, +log_group_name, +log_stream_name +FROM awscc.logs.log_streams +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/metric_filter/index.md b/docs/awscc-docs/providers/awscc/logs/metric_filter/index.md new file mode 100644 index 0000000000..f39f11608b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/metric_filter/index.md @@ -0,0 +1,71 @@ +--- +title: metric_filter +hide_title: false +hide_table_of_contents: false +keywords: + - metric_filter + - 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 +--- +Gets an individual metric_filter resource + +## Overview + + + + + +
Namemetric_filter
TypeResource
Descriptionmetric_filter
Idawscc.logs.metric_filter
+ +## Fields + + + + + + + + +
NameDatatypeDescription
filter_namestringA name for the metric filter.
filter_patternstringPattern that Logs follows to interpret each entry in a log.
log_group_namestringExisting log group that you want to associate with this filter.
metric_transformationsarrayA collection of information that defines how metric data gets emitted.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the metric_filter resource, the following permissions are required: + +### Read +
+logs:DescribeMetricFilters
+ +### Update +
+logs:PutMetricFilter,
+logs:DescribeMetricFilters
+ +### Delete +
+logs:DeleteMetricFilter
+ + +## Example +```sql +SELECT +region, +filter_name, +filter_pattern, +log_group_name, +metric_transformations +FROM awscc.logs.metric_filter +WHERE region = 'us-east-1' +AND data__Identifier = '<LogGroupName>' +AND data__Identifier = '<FilterName>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/metric_filters/index.md b/docs/awscc-docs/providers/awscc/logs/metric_filters/index.md new file mode 100644 index 0000000000..737148befa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/metric_filters/index.md @@ -0,0 +1,61 @@ +--- +title: metric_filters +hide_title: false +hide_table_of_contents: false +keywords: + - metric_filters + - 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 +--- +Retrieves a list of metric_filters in a region + +## Overview + + + + + +
Namemetric_filters
TypeResource
Descriptionmetric_filters
Idawscc.logs.metric_filters
+ +## Fields + + + + + + +
NameDatatypeDescription
log_group_namestringExisting log group that you want to associate with this filter.
filter_namestringA name for the metric filter.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the metric_filters resource, the following permissions are required: + +### Create +
+logs:PutMetricFilter,
+logs:DescribeMetricFilters
+ +### List +
+logs:DescribeMetricFilters
+ + +## Example +```sql +SELECT +region, +log_group_name, +filter_name +FROM awscc.logs.metric_filters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/query_definition/index.md b/docs/awscc-docs/providers/awscc/logs/query_definition/index.md new file mode 100644 index 0000000000..6b7294390f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/query_definition/index.md @@ -0,0 +1,69 @@ +--- +title: query_definition +hide_title: false +hide_table_of_contents: false +keywords: + - query_definition + - 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 +--- +Gets an individual query_definition resource + +## Overview + + + + + +
Namequery_definition
TypeResource
Descriptionquery_definition
Idawscc.logs.query_definition
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringA name for the saved query definition
query_stringstringThe query string to use for this definition
log_group_namesarrayOptionally define specific log groups as part of your query definition
query_definition_idstringUnique identifier of a query definition
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the query_definition resource, the following permissions are required: + +### Read +
+logs:DescribeQueryDefinitions
+ +### Update +
+logs:PutQueryDefinition
+ +### Delete +
+logs:DeleteQueryDefinition
+ + +## Example +```sql +SELECT +region, +name, +query_string, +log_group_names, +query_definition_id +FROM awscc.logs.query_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<QueryDefinitionId>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/query_definitions/index.md b/docs/awscc-docs/providers/awscc/logs/query_definitions/index.md new file mode 100644 index 0000000000..ed393dedac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/query_definitions/index.md @@ -0,0 +1,58 @@ +--- +title: query_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - query_definitions + - 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 +--- +Retrieves a list of query_definitions in a region + +## Overview + + + + + +
Namequery_definitions
TypeResource
Descriptionquery_definitions
Idawscc.logs.query_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
query_definition_idstringUnique identifier of a query definition
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the query_definitions resource, the following permissions are required: + +### Create +
+logs:PutQueryDefinition
+ +### List +
+logs:DescribeQueryDefinitions
+ + +## Example +```sql +SELECT +region, +query_definition_id +FROM awscc.logs.query_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/resource_policies/index.md b/docs/awscc-docs/providers/awscc/logs/resource_policies/index.md new file mode 100644 index 0000000000..0f6b981109 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/resource_policies/index.md @@ -0,0 +1,59 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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 +--- +Retrieves a list of resource_policies in a region + +## Overview + + + + + +
Nameresource_policies
TypeResource
Descriptionresource_policies
Idawscc.logs.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_namestringA name for resource policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies
+ +### List +
+logs:DescribeResourcePolicies
+ + +## Example +```sql +SELECT +region, +policy_name +FROM awscc.logs.resource_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/resource_policy/index.md b/docs/awscc-docs/providers/awscc/logs/resource_policy/index.md new file mode 100644 index 0000000000..f6d755ab8d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/resource_policy/index.md @@ -0,0 +1,67 @@ +--- +title: resource_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy + - 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 +--- +Gets an individual resource_policy resource + +## Overview + + + + + +
Nameresource_policy
TypeResource
Descriptionresource_policy
Idawscc.logs.resource_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_namestringA name for resource policy
policy_documentstringThe policy document
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +
+logs:DescribeResourcePolicies
+ +### Update +
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DeleteResourcePolicy
+ +### Delete +
+logs:DeleteResourcePolicy
+ + +## Example +```sql +SELECT +region, +policy_name, +policy_document +FROM awscc.logs.resource_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<PolicyName>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md b/docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md new file mode 100644 index 0000000000..915e77e9c9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md @@ -0,0 +1,76 @@ +--- +title: subscription_filter +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_filter + - 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 +--- +Gets an individual subscription_filter resource + +## Overview + + + + + +
Namesubscription_filter
TypeResource
Descriptionsubscription_filter
Idawscc.logs.subscription_filter
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
filter_namestringThe name of the filter generated by resource.
destination_arnstringThe Amazon Resource Name (ARN) of the destination.
filter_patternstringThe filtering expressions that restrict what gets delivered to the destination AWS resource.
log_group_namestringExisting log group that you want to associate with this filter.
role_arnstringThe ARN of an IAM role that grants CloudWatch Logs 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.
distributionstringThe method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subscription_filter resource, the following permissions are required: + +### Read +
+logs:DescribeSubscriptionFilters
+ +### Update +
+iam:PassRole,
+logs:PutSubscriptionFilter,
+logs:DescribeSubscriptionFilters
+ +### Delete +
+logs:DeleteSubscriptionFilter
+ + +## Example +```sql +SELECT +region, +filter_name, +destination_arn, +filter_pattern, +log_group_name, +role_arn, +distribution +FROM awscc.logs.subscription_filter +WHERE region = 'us-east-1' +AND data__Identifier = '<FilterName>' +AND data__Identifier = '<LogGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md b/docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md new file mode 100644 index 0000000000..0f10000838 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md @@ -0,0 +1,62 @@ +--- +title: subscription_filters +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_filters + - 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 +--- +Retrieves a list of subscription_filters in a region + +## Overview + + + + + +
Namesubscription_filters
TypeResource
Descriptionsubscription_filters
Idawscc.logs.subscription_filters
+ +## Fields + + + + + + +
NameDatatypeDescription
filter_namestringThe name of the filter generated by resource.
log_group_namestringExisting log group that you want to associate with this filter.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subscription_filters resource, the following permissions are required: + +### Create +
+iam:PassRole,
+logs:PutSubscriptionFilter,
+logs:DescribeSubscriptionFilters
+ +### List +
+logs:DescribeSubscriptionFilters
+ + +## Example +```sql +SELECT +region, +filter_name, +log_group_name +FROM awscc.logs.subscription_filters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutequipment/index.md b/docs/awscc-docs/providers/awscc/lookoutequipment/index.md new file mode 100644 index 0000000000..e1036bc584 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutequipment/index.md @@ -0,0 +1,39 @@ +--- +title: lookoutequipment +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The lookoutequipment service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+inference_scheduler +
+
+inference_schedulers +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/lookoutequipment/inference_scheduler/index.md b/docs/awscc-docs/providers/awscc/lookoutequipment/inference_scheduler/index.md new file mode 100644 index 0000000000..4db1d5d4f2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutequipment/inference_scheduler/index.md @@ -0,0 +1,86 @@ +--- +title: inference_scheduler +hide_title: false +hide_table_of_contents: false +keywords: + - inference_scheduler + - 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 +--- +Gets an individual inference_scheduler resource + +## Overview + + + + + +
Nameinference_scheduler
TypeResource
Descriptioninference_scheduler
Idawscc.lookoutequipment.inference_scheduler
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
data_delay_offset_in_minutesintegerA period of time (in minutes) by which inference on the data is delayed after the data starts.
data_input_configurationobjectSpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
data_output_configurationobjectSpecifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
data_upload_frequencystringHow often data is uploaded to the source S3 bucket for the input data.
inference_scheduler_namestringThe name of the inference scheduler being created.
model_namestringThe name of the previously trained ML model being used to create the inference scheduler.
role_arnstringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
server_side_kms_key_idstringProvides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.
tagsarrayAny tags associated with the inference scheduler.
inference_scheduler_arnstringThe Amazon Resource Name (ARN) of the inference scheduler being created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the inference_scheduler resource, the following permissions are required: + +### Read +
+lookoutequipment:DescribeInferenceScheduler
+ +### Delete +
+lookoutequipment:DeleteInferenceScheduler,
+lookoutequipment:StopInferenceScheduler,
+lookoutequipment:DescribeInferenceScheduler
+ +### Update +
+lookoutequipment:UpdateInferenceScheduler,
+lookoutequipment:DescribeInferenceScheduler,
+lookoutequipment:StopInferenceScheduler,
+lookoutequipment:StartInferenceScheduler
+ + +## Example +```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, +tags, +inference_scheduler_arn +FROM awscc.lookoutequipment.inference_scheduler +WHERE region = 'us-east-1' +AND data__Identifier = '<InferenceSchedulerName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md b/docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md new file mode 100644 index 0000000000..75a55da279 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md @@ -0,0 +1,60 @@ +--- +title: inference_schedulers +hide_title: false +hide_table_of_contents: false +keywords: + - inference_schedulers + - 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 +--- +Retrieves a list of inference_schedulers in a region + +## Overview + + + + + +
Nameinference_schedulers
TypeResource
Descriptioninference_schedulers
Idawscc.lookoutequipment.inference_schedulers
+ +## Fields + + + + + +
NameDatatypeDescription
inference_scheduler_namestringThe name of the inference scheduler being created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the inference_schedulers resource, the following permissions are required: + +### Create +
+iam:PassRole,
+lookoutequipment:CreateInferenceScheduler,
+lookoutequipment:DescribeInferenceScheduler
+ +### List +
+lookoutequipment:ListInferenceSchedulers
+ + +## Example +```sql +SELECT +region, +inference_scheduler_name +FROM awscc.lookoutequipment.inference_schedulers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md new file mode 100644 index 0000000000..bf5443223a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md @@ -0,0 +1,69 @@ +--- +title: alert +hide_title: false +hide_table_of_contents: false +keywords: + - alert + - 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 +--- +Gets an individual alert resource + +## Overview + + + + + +
Namealert
TypeResource
Descriptionalert
Idawscc.lookoutmetrics.alert
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
alert_namestringThe name of the alert. If not provided, a name is generated automatically.
arnstringARN assigned to the alert.
alert_descriptionstringA description for the alert.
anomaly_detector_arnstringThe Amazon resource name (ARN) of the Anomaly Detector to alert.
alert_sensitivity_thresholdintegerA number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
actionobjectThe action to be taken by the alert when an anomaly is detected.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alert resource, the following permissions are required: + +### Read +
+lookoutmetrics:DescribeAlert
+ +### Delete +
+lookoutmetrics:DeleteAlert
+ + +## Example +```sql +SELECT +region, +alert_name, +arn, +alert_description, +anomaly_detector_arn, +alert_sensitivity_threshold, +action +FROM awscc.lookoutmetrics.alert +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md new file mode 100644 index 0000000000..3a10c3f4fa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md @@ -0,0 +1,59 @@ +--- +title: alerts +hide_title: false +hide_table_of_contents: false +keywords: + - alerts + - 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 +--- +Retrieves a list of alerts in a region + +## Overview + + + + + +
Namealerts
TypeResource
Descriptionalerts
Idawscc.lookoutmetrics.alerts
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedARN assigned to the alert.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the alerts resource, the following permissions are required: + +### Create +
+lookoutmetrics:CreateAlert,
+iam:PassRole
+ +### List +
+lookoutmetrics:ListAlerts
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.lookoutmetrics.alerts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md new file mode 100644 index 0000000000..5ff2530fc9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md @@ -0,0 +1,77 @@ +--- +title: anomaly_detector +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_detector + - 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 +--- +Gets an individual anomaly_detector resource + +## Overview + + + + + +
Nameanomaly_detector
TypeResource
Descriptionanomaly_detector
Idawscc.lookoutmetrics.anomaly_detector
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
anomaly_detector_namestringName for the Amazon Lookout for Metrics Anomaly Detector
anomaly_detector_descriptionstringA description for the AnomalyDetector.
anomaly_detector_configobjectConfiguration options for the AnomalyDetector
metric_set_listarrayList of metric sets for anomaly detection
kms_key_arnstringKMS key used to encrypt the AnomalyDetector data
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the anomaly_detector resource, the following permissions are required: + +### Read +
+lookoutmetrics:DescribeAnomalyDetector,
+lookoutmetrics:DescribeMetricSet,
+lookoutmetrics:ListMetricSets
+ +### Update +
+lookoutmetrics:UpdateAnomalyDetector,
+lookoutmetrics:UpdateMetricSet
+ +### Delete +
+lookoutmetrics:DescribeAnomalyDetector,
+lookoutmetrics:DeleteAnomalyDetector
+ + +## Example +```sql +SELECT +region, +arn, +anomaly_detector_name, +anomaly_detector_description, +anomaly_detector_config, +metric_set_list, +kms_key_arn +FROM awscc.lookoutmetrics.anomaly_detector +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md new file mode 100644 index 0000000000..623881d8cb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md @@ -0,0 +1,61 @@ +--- +title: anomaly_detectors +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_detectors + - 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 +--- +Retrieves a list of anomaly_detectors in a region + +## Overview + + + + + +
Nameanomaly_detectors
TypeResource
Descriptionanomaly_detectors
Idawscc.lookoutmetrics.anomaly_detectors
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the anomaly_detectors resource, the following permissions are required: + +### Create +
+lookoutmetrics:CreateAnomalyDetector,
+lookoutmetrics:DeleteAnomalyDetector,
+lookoutmetrics:CreateMetricSet,
+iam:PassRole
+ +### List +
+lookoutmetrics:ListAnomalyDetectors
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.lookoutmetrics.anomaly_detectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/index.md new file mode 100644 index 0000000000..f9beb903fc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutmetrics/index.md @@ -0,0 +1,41 @@ +--- +title: lookoutmetrics +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The lookoutmetrics service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+alert
+alerts +
+
+anomaly_detector
+anomaly_detectors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/lookoutvision/index.md b/docs/awscc-docs/providers/awscc/lookoutvision/index.md new file mode 100644 index 0000000000..a7faef8345 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutvision/index.md @@ -0,0 +1,39 @@ +--- +title: lookoutvision +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The lookoutvision service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+project +
+
+projects +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/lookoutvision/project/index.md b/docs/awscc-docs/providers/awscc/lookoutvision/project/index.md new file mode 100644 index 0000000000..191cc96c96 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutvision/project/index.md @@ -0,0 +1,65 @@ +--- +title: project +hide_title: false +hide_table_of_contents: false +keywords: + - project + - 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 +--- +Gets an individual project resource + +## Overview + + + + + +
Nameproject
TypeResource
Descriptionproject
Idawscc.lookoutvision.project
+ +## Fields + + + + + + +
NameDatatypeDescription
arnstring
project_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +
+lookoutvision:DescribeProject
+ +### Update +
+
+ +### Delete +
+lookoutvision:DeleteProject
+ + +## Example +```sql +SELECT +region, +arn, +project_name +FROM awscc.lookoutvision.project +WHERE region = 'us-east-1' +AND data__Identifier = '<ProjectName>' +``` diff --git a/docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md b/docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md new file mode 100644 index 0000000000..7ba7fcb2ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md @@ -0,0 +1,58 @@ +--- +title: projects +hide_title: false +hide_table_of_contents: false +keywords: + - projects + - 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 +--- +Retrieves a list of projects in a region + +## Overview + + + + + +
Nameprojects
TypeResource
Descriptionprojects
Idawscc.lookoutvision.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_nameundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +
+lookoutvision:CreateProject
+ +### List +
+lookoutvision:ListProjects
+ + +## Example +```sql +SELECT +region, +project_name +FROM awscc.lookoutvision.projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/m2/application/index.md b/docs/awscc-docs/providers/awscc/m2/application/index.md new file mode 100644 index 0000000000..e5a590f895 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/m2/application/index.md @@ -0,0 +1,90 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.m2.application
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
application_arnstring
application_idstring
definitionundefined
descriptionstring
engine_typestring
kms_key_idstringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
namestring
role_arnstring
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+m2:GetApplication,
+m2:ListTagsForResource
+ +### Update +
+m2:UpdateApplication,
+m2:GetApplication,
+m2:ListTagsForResource,
+m2:TagResource,
+m2:UntagResource,
+s3:GetObject,
+s3:ListBucket
+ +### Delete +
+elasticloadbalancing:DeleteListener,
+elasticloadbalancing:DeleteTargetGroup,
+logs:DeleteLogDelivery,
+m2:GetApplication,
+m2:DeleteApplication
+ + +## Example +```sql +SELECT +region, +application_arn, +application_id, +definition, +description, +engine_type, +kms_key_id, +name, +role_arn, +tags +FROM awscc.m2.application +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/m2/applications/index.md b/docs/awscc-docs/providers/awscc/m2/applications/index.md new file mode 100644 index 0000000000..d8c1cdf619 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/m2/applications/index.md @@ -0,0 +1,66 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.m2.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+m2:CreateApplication,
+m2:GetApplication,
+m2:ListTagsForResource,
+m2:TagResource,
+s3:GetObject,
+s3:ListBucket,
+kms:DescribeKey,
+kms:CreateGrant,
+iam:PassRole
+ +### List +
+m2:ListApplications
+ + +## Example +```sql +SELECT +region, +application_arn +FROM awscc.m2.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/m2/environment/index.md b/docs/awscc-docs/providers/awscc/m2/environment/index.md new file mode 100644 index 0000000000..f5ef91f502 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/m2/environment/index.md @@ -0,0 +1,98 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.m2.environment
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the environment.
engine_typestring
engine_versionstringThe version of the runtime engine for the environment.
environment_arnstringThe Amazon Resource Name (ARN) of the runtime environment.
environment_idstringThe unique identifier of the environment.
high_availability_configobject
instance_typestringThe type of instance underlying the environment.
kms_key_idstringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
namestringThe name of the environment.
preferred_maintenance_windowstringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
publicly_accessiblebooleanSpecifies whether the environment is publicly accessible.
security_group_idsarrayThe list of security groups for the VPC associated with this environment.
storage_configurationsarrayThe storage configurations defined for the runtime environment.
subnet_idsarrayThe unique identifiers of the subnets assigned to this runtime environment.
tagsobjectTags associated to this environment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+m2:ListTagsForResource,
+m2:GetEnvironment
+ +### Update +
+m2:TagResource,
+m2:UntagResource,
+m2:ListTagsForResource,
+m2:GetEnvironment,
+m2:UpdateEnvironment
+ +### Delete +
+elasticloadbalancing:DeleteLoadBalancer,
+m2:DeleteEnvironment,
+m2:GetEnvironment
+ + +## Example +```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, +tags +FROM awscc.m2.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<EnvironmentArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/m2/environments/index.md b/docs/awscc-docs/providers/awscc/m2/environments/index.md new file mode 100644 index 0000000000..48805f6ab8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/m2/environments/index.md @@ -0,0 +1,76 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.m2.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_arnstringThe Amazon Resource Name (ARN) of the runtime environment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+ec2:CreateNetworkInterface,
+ec2:CreateNetworkInterfacePermission,
+ec2:DescribeNetworkInterfaces,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+ec2:ModifyNetworkInterfaceAttribute,
+elasticfilesystem:DescribeMountTargets,
+elasticloadbalancing:CreateLoadBalancer,
+elasticloadbalancing:AddTags,
+fsx:DescribeFileSystems,
+iam:CreateServiceLinkedRole,
+kms:DescribeKey,
+kms:CreateGrant,
+m2:CreateEnvironment,
+m2:GetEnvironment,
+m2:ListTagsForResource,
+m2:TagResource
+ +### List +
+m2:ListEnvironments
+ + +## Example +```sql +SELECT +region, +environment_arn +FROM awscc.m2.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/m2/index.md b/docs/awscc-docs/providers/awscc/m2/index.md new file mode 100644 index 0000000000..d47bbaae1c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/m2/index.md @@ -0,0 +1,41 @@ +--- +title: m2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The m2 service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+application
+applications +
+
+environment
+environments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/macie/allow_list/index.md b/docs/awscc-docs/providers/awscc/macie/allow_list/index.md new file mode 100644 index 0000000000..cb4e7cce69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/allow_list/index.md @@ -0,0 +1,78 @@ +--- +title: allow_list +hide_title: false +hide_table_of_contents: false +keywords: + - allow_list + - 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 +--- +Gets an individual allow_list resource + +## Overview + + + + + +
Nameallow_list
TypeResource
Descriptionallow_list
Idawscc.macie.allow_list
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringName of AllowList.
descriptionstringDescription of AllowList.
criteriaobjectAllowList criteria.
idstringAllowList ID.
arnstringAllowList ARN.
statusstringAllowList status.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the allow_list resource, the following permissions are required: + +### Read +
+macie2:GetAllowList
+ +### Update +
+macie2:UpdateAllowList,
+macie2:GetAllowList,
+macie2:TagResource,
+macie2:UntagResource
+ +### Delete +
+macie2:DeleteAllowList
+ + +## Example +```sql +SELECT +region, +name, +description, +criteria, +id, +arn, +status, +tags +FROM awscc.macie.allow_list +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/macie/allow_lists/index.md b/docs/awscc-docs/providers/awscc/macie/allow_lists/index.md new file mode 100644 index 0000000000..cc447de094 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/allow_lists/index.md @@ -0,0 +1,60 @@ +--- +title: allow_lists +hide_title: false +hide_table_of_contents: false +keywords: + - allow_lists + - 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 +--- +Retrieves a list of allow_lists in a region + +## Overview + + + + + +
Nameallow_lists
TypeResource
Descriptionallow_lists
Idawscc.macie.allow_lists
+ +## Fields + + + + + +
NameDatatypeDescription
idstringAllowList ID.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the allow_lists resource, the following permissions are required: + +### Create +
+macie2:CreateAllowList,
+macie2:GetAllowList,
+macie2:TagResource
+ +### List +
+macie2:ListAllowLists
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.macie.allow_lists +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/macie/custom_data_identifier/index.md b/docs/awscc-docs/providers/awscc/macie/custom_data_identifier/index.md new file mode 100644 index 0000000000..45fbeb34e6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/custom_data_identifier/index.md @@ -0,0 +1,80 @@ +--- +title: custom_data_identifier +hide_title: false +hide_table_of_contents: false +keywords: + - custom_data_identifier + - 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 +--- +Gets an individual custom_data_identifier resource + +## Overview + + + + + +
Namecustom_data_identifier
TypeResource
Descriptioncustom_data_identifier
Idawscc.macie.custom_data_identifier
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of custom data identifier.
descriptionstringDescription of custom data identifier.
regexstringRegular expression for custom data identifier.
maximum_match_distanceintegerMaximum match distance.
keywordsarrayKeywords to be matched against.
ignore_wordsarrayWords to be ignored.
idstringCustom data identifier ID.
arnstringCustom data identifier ARN.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_data_identifier resource, the following permissions are required: + +### Read +
+macie2:GetCustomDataIdentifier
+ +### Delete +
+macie2:DeleteCustomDataIdentifier
+ +### Update +
+macie2:TagResource,
+macie2:UntagResource
+ + +## Example +```sql +SELECT +region, +name, +description, +regex, +maximum_match_distance, +keywords, +ignore_words, +id, +arn, +tags +FROM awscc.macie.custom_data_identifier +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/macie/custom_data_identifiers/index.md b/docs/awscc-docs/providers/awscc/macie/custom_data_identifiers/index.md new file mode 100644 index 0000000000..ed21a58176 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/custom_data_identifiers/index.md @@ -0,0 +1,60 @@ +--- +title: custom_data_identifiers +hide_title: false +hide_table_of_contents: false +keywords: + - custom_data_identifiers + - 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 +--- +Retrieves a list of custom_data_identifiers in a region + +## Overview + + + + + +
Namecustom_data_identifiers
TypeResource
Descriptioncustom_data_identifiers
Idawscc.macie.custom_data_identifiers
+ +## Fields + + + + + +
NameDatatypeDescription
idstringCustom data identifier ID.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the custom_data_identifiers resource, the following permissions are required: + +### Create +
+macie2:CreateCustomDataIdentifier,
+macie2:GetCustomDataIdentifier,
+macie2:TagResource
+ +### List +
+macie2:ListCustomDataIdentifiers
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.macie.custom_data_identifiers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/macie/findings_filter/index.md b/docs/awscc-docs/providers/awscc/macie/findings_filter/index.md new file mode 100644 index 0000000000..47cc0a3eca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/findings_filter/index.md @@ -0,0 +1,80 @@ +--- +title: findings_filter +hide_title: false +hide_table_of_contents: false +keywords: + - findings_filter + - 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 +--- +Gets an individual findings_filter resource + +## Overview + + + + + +
Namefindings_filter
TypeResource
Descriptionfindings_filter
Idawscc.macie.findings_filter
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringFindings filter name
descriptionstringFindings filter description
finding_criteriaobjectFindings filter criteria.
actionstringFindings filter action.
positionintegerFindings filter position.
idstringFindings filter ID.
arnstringFindings filter ARN.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the findings_filter resource, the following permissions are required: + +### Read +
+macie2:GetFindingsFilter
+ +### Update +
+macie2:GetFindingsFilter,
+macie2:UpdateFindingsFilter,
+macie2:TagResource,
+macie2:UntagResource
+ +### Delete +
+macie2:DeleteFindingsFilter
+ + +## Example +```sql +SELECT +region, +name, +description, +finding_criteria, +action, +position, +id, +arn, +tags +FROM awscc.macie.findings_filter +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/macie/findings_filters/index.md b/docs/awscc-docs/providers/awscc/macie/findings_filters/index.md new file mode 100644 index 0000000000..447d29f112 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/findings_filters/index.md @@ -0,0 +1,60 @@ +--- +title: findings_filters +hide_title: false +hide_table_of_contents: false +keywords: + - findings_filters + - 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 +--- +Retrieves a list of findings_filters in a region + +## Overview + + + + + +
Namefindings_filters
TypeResource
Descriptionfindings_filters
Idawscc.macie.findings_filters
+ +## Fields + + + + + +
NameDatatypeDescription
idstringFindings filter ID.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the findings_filters resource, the following permissions are required: + +### Create +
+macie2:GetFindingsFilter,
+macie2:CreateFindingsFilter,
+macie2:TagResource
+ +### List +
+macie2:ListFindingsFilters
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.macie.findings_filters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/macie/index.md b/docs/awscc-docs/providers/awscc/macie/index.md new file mode 100644 index 0000000000..9ad07552ca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/index.md @@ -0,0 +1,45 @@ +--- +title: macie +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The macie service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+allow_list
+allow_lists
+custom_data_identifier
+custom_data_identifiers +
+
+findings_filter
+findings_filters
+session
+sessions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/macie/session/index.md b/docs/awscc-docs/providers/awscc/macie/session/index.md new file mode 100644 index 0000000000..7c537a483a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/session/index.md @@ -0,0 +1,70 @@ +--- +title: session +hide_title: false +hide_table_of_contents: false +keywords: + - session + - 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 +--- +Gets an individual session resource + +## Overview + + + + + +
Namesession
TypeResource
Descriptionsession
Idawscc.macie.session
+ +## Fields + + + + + + + + +
NameDatatypeDescription
aws_account_idstringAWS account ID of customer
statusstringA enumeration value that specifies the status of the Macie Session.
finding_publishing_frequencystringA enumeration value that specifies how frequently finding updates are published.
service_rolestringService role used by Macie
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the session resource, the following permissions are required: + +### Read +
+macie2:GetMacieSession
+ +### Update +
+macie2:GetMacieSession,
+macie2:UpdateMacieSession
+ +### Delete +
+macie2:DisableMacie
+ + +## Example +```sql +SELECT +region, +aws_account_id, +status, +finding_publishing_frequency, +service_role +FROM awscc.macie.session +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/macie/sessions/index.md b/docs/awscc-docs/providers/awscc/macie/sessions/index.md new file mode 100644 index 0000000000..cbc6d5f8aa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/macie/sessions/index.md @@ -0,0 +1,59 @@ +--- +title: sessions +hide_title: false +hide_table_of_contents: false +keywords: + - sessions + - 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 +--- +Retrieves a list of sessions in a region + +## Overview + + + + + +
Namesessions
TypeResource
Descriptionsessions
Idawscc.macie.sessions
+ +## Fields + + + + + +
NameDatatypeDescription
aws_account_idstringAWS account ID of customer
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sessions resource, the following permissions are required: + +### Create +
+macie2:GetMacieSession,
+macie2:EnableMacie
+ +### List +
+macie2:GetMacieSession
+ + +## Example +```sql +SELECT +region, +aws_account_id +FROM awscc.macie.sessions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md b/docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md new file mode 100644 index 0000000000..50fe90498a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md @@ -0,0 +1,80 @@ +--- +title: accessor +hide_title: false +hide_table_of_contents: false +keywords: + - accessor + - 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 +--- +Gets an individual accessor resource + +## Overview + + + + + +
Nameaccessor
TypeResource
Descriptionaccessor
Idawscc.managedblockchain.accessor
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
billing_tokenstring
creation_datestring
idstring
statusstring
accessor_typestring
network_typestring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the accessor resource, the following permissions are required: + +### Read +
+managedblockchain:GetAccessor
+ +### Update +
+managedblockchain:GetAccessor,
+managedblockchain:CreateAccessor,
+managedblockchain:TagResource,
+managedblockchain:UntagResource
+ +### Delete +
+managedblockchain:DeleteAccessor
+ + +## Example +```sql +SELECT +region, +arn, +billing_token, +creation_date, +id, +status, +accessor_type, +network_type, +tags +FROM awscc.managedblockchain.accessor +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md b/docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md new file mode 100644 index 0000000000..7aa6ef3713 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md @@ -0,0 +1,60 @@ +--- +title: accessors +hide_title: false +hide_table_of_contents: false +keywords: + - accessors + - 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 +--- +Retrieves a list of accessors in a region + +## Overview + + + + + +
Nameaccessors
TypeResource
Descriptionaccessors
Idawscc.managedblockchain.accessors
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the accessors resource, the following permissions are required: + +### Create +
+managedblockchain:CreateAccessor,
+managedblockchain:TagResource,
+managedblockchain:GetAccessor
+ +### List +
+managedblockchain:ListAccessors
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.managedblockchain.accessors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/managedblockchain/index.md b/docs/awscc-docs/providers/awscc/managedblockchain/index.md new file mode 100644 index 0000000000..50e405d2d7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/managedblockchain/index.md @@ -0,0 +1,39 @@ +--- +title: managedblockchain +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The managedblockchain service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+accessor +
+
+accessors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridge/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridge/index.md new file mode 100644 index 0000000000..fbd50bacdf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/bridge/index.md @@ -0,0 +1,81 @@ +--- +title: bridge +hide_title: false +hide_table_of_contents: false +keywords: + - bridge + - 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 +--- +Gets an individual bridge resource + +## Overview + + + + + +
Namebridge
TypeResource
Descriptionbridge
Idawscc.mediaconnect.bridge
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the bridge.
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
placement_arnstringThe placement Amazon Resource Number (ARN) of the bridge.
bridge_statestring
source_failover_configobject
outputsarrayThe outputs on this bridge.
sourcesarrayThe sources on this bridge.
ingress_gateway_bridgeobject
egress_gateway_bridgeobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bridge resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeBridge
+ +### Update +
+mediaconnect:DescribeBridge,
+mediaconnect:UpdateBridge
+ +### Delete +
+mediaconnect:DescribeBridge,
+mediaconnect:DeleteBridge
+ + +## Example +```sql +SELECT +region, +name, +bridge_arn, +placement_arn, +bridge_state, +source_failover_config, +outputs, +sources, +ingress_gateway_bridge, +egress_gateway_bridge +FROM awscc.mediaconnect.bridge +WHERE region = 'us-east-1' +AND data__Identifier = '<BridgeArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md new file mode 100644 index 0000000000..02215c94ca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md @@ -0,0 +1,69 @@ +--- +title: bridge_output +hide_title: false +hide_table_of_contents: false +keywords: + - bridge_output + - 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 +--- +Gets an individual bridge_output resource + +## Overview + + + + + +
Namebridge_output
TypeResource
Descriptionbridge_output
Idawscc.mediaconnect.bridge_output
+ +## Fields + + + + + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
network_outputobjectThe output of the bridge.
namestringThe network output name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bridge_output resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeBridge
+ +### Update +
+mediaconnect:DescribeBridge,
+mediaconnect:UpdateBridgeOutput
+ +### Delete +
+mediaconnect:RemoveBridgeOutput
+ + +## Example +```sql +SELECT +region, +bridge_arn, +network_output, +name +FROM awscc.mediaconnect.bridge_output +WHERE region = 'us-east-1' +AND data__Identifier = '<BridgeArn>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_outputs/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_outputs/index.md new file mode 100644 index 0000000000..37a370f551 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_outputs/index.md @@ -0,0 +1,57 @@ +--- +title: bridge_outputs +hide_title: false +hide_table_of_contents: false +keywords: + - bridge_outputs + - 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 +--- +Retrieves a list of bridge_outputs in a region + +## Overview + + + + + +
Namebridge_outputs
TypeResource
Descriptionbridge_outputs
Idawscc.mediaconnect.bridge_outputs
+ +## Fields + + + + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
namestringThe network output name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bridge_outputs resource, the following permissions are required: + +### Create +
+mediaconnect:AddBridgeOutputs,
+mediaconnect:DescribeBridge
+ + +## Example +```sql +SELECT +region, +bridge_arn, +name +FROM awscc.mediaconnect.bridge_outputs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md new file mode 100644 index 0000000000..043a451800 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md @@ -0,0 +1,71 @@ +--- +title: bridge_source +hide_title: false +hide_table_of_contents: false +keywords: + - bridge_source + - 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 +--- +Gets an individual bridge_source resource + +## Overview + + + + + +
Namebridge_source
TypeResource
Descriptionbridge_source
Idawscc.mediaconnect.bridge_source
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringThe name of the source.
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
flow_sourceobject
network_sourceobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bridge_source resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeBridge
+ +### Update +
+mediaconnect:DescribeBridge,
+mediaconnect:UpdateBridgeSource
+ +### Delete +
+mediaconnect:RemoveBridgeSource
+ + +## Example +```sql +SELECT +region, +name, +bridge_arn, +flow_source, +network_source +FROM awscc.mediaconnect.bridge_source +WHERE region = 'us-east-1' +AND data__Identifier = '<BridgeArn>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_sources/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_sources/index.md new file mode 100644 index 0000000000..0536189f3e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_sources/index.md @@ -0,0 +1,57 @@ +--- +title: bridge_sources +hide_title: false +hide_table_of_contents: false +keywords: + - bridge_sources + - 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 +--- +Retrieves a list of bridge_sources in a region + +## Overview + + + + + +
Namebridge_sources
TypeResource
Descriptionbridge_sources
Idawscc.mediaconnect.bridge_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
namestringThe name of the source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bridge_sources resource, the following permissions are required: + +### Create +
+mediaconnect:AddBridgeSources,
+mediaconnect:DescribeBridge
+ + +## Example +```sql +SELECT +region, +bridge_arn, +name +FROM awscc.mediaconnect.bridge_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md new file mode 100644 index 0000000000..7ee3331803 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md @@ -0,0 +1,59 @@ +--- +title: bridges +hide_title: false +hide_table_of_contents: false +keywords: + - bridges + - 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 +--- +Retrieves a list of bridges in a region + +## Overview + + + + + +
Namebridges
TypeResource
Descriptionbridges
Idawscc.mediaconnect.bridges
+ +## Fields + + + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bridges resource, the following permissions are required: + +### Create +
+mediaconnect:CreateBridge,
+mediaconnect:DescribeBridge
+ +### List +
+mediaconnect:ListBridges
+ + +## Example +```sql +SELECT +region, +bridge_arn +FROM awscc.mediaconnect.bridges +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md new file mode 100644 index 0000000000..0593dde1a9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md @@ -0,0 +1,76 @@ +--- +title: flow +hide_title: false +hide_table_of_contents: false +keywords: + - flow + - 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 +--- +Gets an individual flow resource + +## Overview + + + + + +
Nameflow
TypeResource
Descriptionflow
Idawscc.mediaconnect.flow
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
namestringThe name of the flow.
availability_zonestringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
flow_availability_zonestringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)
sourceobjectThe source of the flow.
source_failover_configobjectThe source failover config of the flow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeFlow
+ +### Update +
+mediaconnect:DescribeFlow,
+mediaconnect:UpdateFlow,
+mediaconnect:UpdateFlowSource
+ +### Delete +
+mediaconnect:DescribeFlow,
+mediaconnect:DeleteFlow
+ + +## Example +```sql +SELECT +region, +flow_arn, +name, +availability_zone, +flow_availability_zone, +source, +source_failover_config +FROM awscc.mediaconnect.flow +WHERE region = 'us-east-1' +AND data__Identifier = '<FlowArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md new file mode 100644 index 0000000000..3068d4c5da --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md @@ -0,0 +1,79 @@ +--- +title: flow_entitlement +hide_title: false +hide_table_of_contents: false +keywords: + - flow_entitlement + - 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 +--- +Gets an individual flow_entitlement resource + +## Overview + + + + + +
Nameflow_entitlement
TypeResource
Descriptionflow_entitlement
Idawscc.mediaconnect.flow_entitlement
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe ARN of the flow.
entitlement_arnstringThe ARN of the entitlement.
data_transfer_subscriber_fee_percentintegerPercentage from 0-100 of the data transfer cost to be billed to the subscriber.
descriptionstringA description of the entitlement.
encryptionobjectThe type of encryption that will be used on the output that is associated with this entitlement.
entitlement_statusstring An indication of whether the entitlement is enabled.
namestringThe name of the entitlement.
subscribersarrayThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_entitlement resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeFlow
+ +### Update +
+mediaconnect:DescribeFlow,
+mediaconnect:UpdateFlowEntitlement
+ +### Delete +
+mediaconnect:DescribeFlow,
+mediaconnect:RevokeFlowEntitlement
+ + +## Example +```sql +SELECT +region, +flow_arn, +entitlement_arn, +data_transfer_subscriber_fee_percent, +description, +encryption, +entitlement_status, +name, +subscribers +FROM awscc.mediaconnect.flow_entitlement +WHERE region = 'us-east-1' +AND data__Identifier = '<EntitlementArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md new file mode 100644 index 0000000000..02d3b85087 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md @@ -0,0 +1,59 @@ +--- +title: flow_entitlements +hide_title: false +hide_table_of_contents: false +keywords: + - flow_entitlements + - 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 +--- +Retrieves a list of flow_entitlements in a region + +## Overview + + + + + +
Nameflow_entitlements
TypeResource
Descriptionflow_entitlements
Idawscc.mediaconnect.flow_entitlements
+ +## Fields + + + + + +
NameDatatypeDescription
entitlement_arnstringThe ARN of the entitlement.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_entitlements resource, the following permissions are required: + +### Create +
+iam:PassRole,
+mediaconnect:GrantFlowEntitlements
+ +### List +
+mediaconnect:DescribeFlow
+ + +## Example +```sql +SELECT +region, +entitlement_arn +FROM awscc.mediaconnect.flow_entitlements +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md new file mode 100644 index 0000000000..8550330cc6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md @@ -0,0 +1,93 @@ +--- +title: flow_output +hide_title: false +hide_table_of_contents: false +keywords: + - flow_output + - 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 +--- +Gets an individual flow_output resource + +## Overview + + + + + +
Nameflow_output
TypeResource
Descriptionflow_output
Idawscc.mediaconnect.flow_output
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
output_arnstringThe ARN of the output.
cidr_allow_listarrayThe 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.
encryptionobjectThe type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
descriptionstringA description of the output.
destinationstringThe address where you want to send the output.
max_latencyintegerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
min_latencyintegerThe minimum latency in milliseconds.
namestringThe name of the output. This value must be unique within the current flow.
portintegerThe port to use when content is distributed to this output.
protocolstringThe protocol that is used by the source or output.
remote_idstringThe remote ID for the Zixi-pull stream.
smoothing_latencyintegerThe smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
stream_idstringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
vpc_interface_attachmentobjectThe name of the VPC interface attachment to use for this output.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_output resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeFlow
+ +### Update +
+mediaconnect:DescribeFlow,
+mediaconnect:UpdateFlowOutput
+ +### Delete +
+mediaconnect:DescribeFlow,
+mediaconnect:RemoveFlowOutput
+ + +## Example +```sql +SELECT +region, +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 +FROM awscc.mediaconnect.flow_output +WHERE region = 'us-east-1' +AND data__Identifier = '<OutputArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md new file mode 100644 index 0000000000..93e9dfd931 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md @@ -0,0 +1,59 @@ +--- +title: flow_outputs +hide_title: false +hide_table_of_contents: false +keywords: + - flow_outputs + - 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 +--- +Retrieves a list of flow_outputs in a region + +## Overview + + + + + +
Nameflow_outputs
TypeResource
Descriptionflow_outputs
Idawscc.mediaconnect.flow_outputs
+ +## Fields + + + + + +
NameDatatypeDescription
output_arnstringThe ARN of the output.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_outputs resource, the following permissions are required: + +### Create +
+iam:PassRole,
+mediaconnect:AddFlowOutputs
+ +### List +
+mediaconnect:DescribeFlow
+ + +## Example +```sql +SELECT +region, +output_arn +FROM awscc.mediaconnect.flow_outputs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md new file mode 100644 index 0000000000..dc3c7ac5ae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md @@ -0,0 +1,105 @@ +--- +title: flow_source +hide_title: false +hide_table_of_contents: false +keywords: + - flow_source + - 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 +--- +Gets an individual flow_source resource + +## Overview + + + + + +
Nameflow_source
TypeResource
Descriptionflow_source
Idawscc.mediaconnect.flow_source
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe ARN of the flow.
source_arnstringThe ARN of the source.
decryptionobjectThe type of encryption that is used on the content ingested from this source.
descriptionstringA description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
entitlement_arnstringThe 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.
gateway_bridge_sourceobjectThe source configuration for cloud flows receiving a stream from a bridge.
ingest_ipstringThe IP address that the flow will be listening on for incoming content.
ingest_portintegerThe port that the flow will be listening on for incoming content.
max_bitrateintegerThe smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
max_latencyintegerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
min_latencyintegerThe minimum latency in milliseconds.
namestringThe name of the source.
protocolstringThe protocol that is used by the source.
sender_ip_addressstringThe IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
sender_control_portintegerThe port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
stream_idstringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
source_ingest_portstringThe port that the flow will be listening on for incoming content.(ReadOnly)
source_listener_addressstringSource IP or domain name for SRT-caller protocol.
source_listener_portintegerSource port for SRT-caller protocol.
vpc_interface_namestringThe name of the VPC Interface this Source is configured with.
whitelist_cidrstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_source resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeFlow
+ +### Update +
+mediaconnect:DescribeFlow,
+mediaconnect:UpdateFlowSource
+ +### Delete +
+mediaconnect:DescribeFlow,
+mediaconnect:RemoveFlowSource
+ + +## Example +```sql +SELECT +region, +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 awscc.mediaconnect.flow_source +WHERE region = 'us-east-1' +AND data__Identifier = '<SourceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md new file mode 100644 index 0000000000..b4203eac20 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md @@ -0,0 +1,61 @@ +--- +title: flow_sources +hide_title: false +hide_table_of_contents: false +keywords: + - flow_sources + - 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 +--- +Retrieves a list of flow_sources in a region + +## Overview + + + + + +
Nameflow_sources
TypeResource
Descriptionflow_sources
Idawscc.mediaconnect.flow_sources
+ +## Fields + + + + + +
NameDatatypeDescription
source_arnstringThe ARN of the source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_sources resource, the following permissions are required: + +### Create +
+mediaconnect:CreateFlow,
+mediaconnect:DescribeFlow,
+mediaconnect:AddFlowSources,
+iam:PassRole
+ +### List +
+mediaconnect:DescribeFlow
+ + +## Example +```sql +SELECT +region, +source_arn +FROM awscc.mediaconnect.flow_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interface/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interface/index.md new file mode 100644 index 0000000000..80bd225410 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interface/index.md @@ -0,0 +1,77 @@ +--- +title: flow_vpc_interface +hide_title: false +hide_table_of_contents: false +keywords: + - flow_vpc_interface + - 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 +--- +Gets an individual flow_vpc_interface resource + +## Overview + + + + + +
Nameflow_vpc_interface
TypeResource
Descriptionflow_vpc_interface
Idawscc.mediaconnect.flow_vpc_interface
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
namestringImmutable and has to be a unique against other VpcInterfaces in this Flow.
role_arnstringRole Arn MediaConnect can assumes to create ENIs in customer's account.
security_group_idsarraySecurity Group IDs to be used on ENI.
subnet_idstringSubnet must be in the AZ of the Flow
network_interface_idsarrayIDs of the network interfaces created in customer's account by MediaConnect.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_vpc_interface resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeFlow
+ +### Update +
+mediaconnect:DescribeFlow,
+mediaconnect:AddFlowVpcInterfaces,
+mediaconnect:RemoveFlowVpcInterface
+ +### Delete +
+mediaconnect:DescribeFlow,
+mediaconnect:RemoveFlowVpcInterface
+ + +## Example +```sql +SELECT +region, +flow_arn, +name, +role_arn, +security_group_ids, +subnet_id, +network_interface_ids +FROM awscc.mediaconnect.flow_vpc_interface +WHERE region = 'us-east-1' +AND data__Identifier = '<FlowArn>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interfaces/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interfaces/index.md new file mode 100644 index 0000000000..964fabd851 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interfaces/index.md @@ -0,0 +1,62 @@ +--- +title: flow_vpc_interfaces +hide_title: false +hide_table_of_contents: false +keywords: + - flow_vpc_interfaces + - 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 +--- +Retrieves a list of flow_vpc_interfaces in a region + +## Overview + + + + + +
Nameflow_vpc_interfaces
TypeResource
Descriptionflow_vpc_interfaces
Idawscc.mediaconnect.flow_vpc_interfaces
+ +## Fields + + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
namestringImmutable and has to be a unique against other VpcInterfaces in this Flow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flow_vpc_interfaces resource, the following permissions are required: + +### Create +
+iam:PassRole,
+mediaconnect:DescribeFlow,
+mediaconnect:AddFlowVpcInterfaces
+ +### List +
+mediaconnect:DescribeFlow
+ + +## Example +```sql +SELECT +region, +flow_arn, +name +FROM awscc.mediaconnect.flow_vpc_interfaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md new file mode 100644 index 0000000000..7ebfcf50b1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md @@ -0,0 +1,59 @@ +--- +title: flows +hide_title: false +hide_table_of_contents: false +keywords: + - flows + - 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 +--- +Retrieves a list of flows in a region + +## Overview + + + + + +
Nameflows
TypeResource
Descriptionflows
Idawscc.mediaconnect.flows
+ +## Fields + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the flows resource, the following permissions are required: + +### Create +
+mediaconnect:CreateFlow,
+iam:PassRole
+ +### List +
+mediaconnect:ListFlows
+ + +## Example +```sql +SELECT +region, +flow_arn +FROM awscc.mediaconnect.flows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md new file mode 100644 index 0000000000..4c32da54aa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md @@ -0,0 +1,69 @@ +--- +title: gateway +hide_title: false +hide_table_of_contents: false +keywords: + - gateway + - 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 +--- +Gets an individual gateway resource + +## Overview + + + + + +
Namegateway
TypeResource
Descriptiongateway
Idawscc.mediaconnect.gateway
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the gateway. This name can not be modified after the gateway is created.
gateway_arnstringThe Amazon Resource Name (ARN) of the gateway.
gateway_statestringThe current status of the gateway.
egress_cidr_blocksarrayThe 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.
networksarrayThe list of networks in the gateway.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the gateway resource, the following permissions are required: + +### Read +
+mediaconnect:DescribeGateway
+ +### Delete +
+iam:CreateServiceLinkedRole,
+mediaconnect:DescribeGateway,
+mediaconnect:DeleteGateway
+ + +## Example +```sql +SELECT +region, +name, +gateway_arn, +gateway_state, +egress_cidr_blocks, +networks +FROM awscc.mediaconnect.gateway +WHERE region = 'us-east-1' +AND data__Identifier = '<GatewayArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md new file mode 100644 index 0000000000..a25c161440 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md @@ -0,0 +1,60 @@ +--- +title: gateways +hide_title: false +hide_table_of_contents: false +keywords: + - gateways + - 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 +--- +Retrieves a list of gateways in a region + +## Overview + + + + + +
Namegateways
TypeResource
Descriptiongateways
Idawscc.mediaconnect.gateways
+ +## Fields + + + + + +
NameDatatypeDescription
gateway_arnstringThe Amazon Resource Name (ARN) of the gateway.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the gateways resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+mediaconnect:CreateGateway,
+mediaconnect:DescribeGateway
+ +### List +
+mediaconnect:ListGateways
+ + +## Example +```sql +SELECT +region, +gateway_arn +FROM awscc.mediaconnect.gateways +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/index.md new file mode 100644 index 0000000000..8f54b333f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediaconnect/index.md @@ -0,0 +1,55 @@ +--- +title: mediaconnect +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The mediaconnect service documentation. + +:::info Service Summary + +
+
+total resources: 18
+total selectable resources: 18
+total methods: 18
+
+
+ +::: + +## Resources +
+
+bridge
+bridge_output
+bridge_outputs
+bridge_source
+bridge_sources
+bridges
+flow
+flow_entitlement
+flow_entitlements +
+
+flow_output
+flow_outputs
+flow_source
+flow_sources
+flow_vpc_interface
+flow_vpc_interfaces
+flows
+gateway
+gateways +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/medialive/index.md b/docs/awscc-docs/providers/awscc/medialive/index.md new file mode 100644 index 0000000000..b9f6bdd92f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/medialive/index.md @@ -0,0 +1,41 @@ +--- +title: medialive +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The medialive service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+multiplex
+multiplexes +
+
+multiplexprogram
+multiplexprograms +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/medialive/multiplex/index.md b/docs/awscc-docs/providers/awscc/medialive/multiplex/index.md new file mode 100644 index 0000000000..e020493be4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/medialive/multiplex/index.md @@ -0,0 +1,85 @@ +--- +title: multiplex +hide_title: false +hide_table_of_contents: false +keywords: + - multiplex + - 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 +--- +Gets an individual multiplex resource + +## Overview + + + + + +
Namemultiplex
TypeResource
Descriptionmultiplex
Idawscc.medialive.multiplex
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe unique arn of the multiplex.
availability_zonesarrayA list of availability zones for the multiplex.
destinationsarrayA list of the multiplex output destinations.
idstringThe unique id of the multiplex.
multiplex_settingsobjectConfiguration for a multiplex event.
namestringName of multiplex.
pipelines_running_countintegerThe number of currently healthy pipelines.
program_countintegerThe number of programs in the multiplex.
statestring
tagsarrayA collection of key-value pairs.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multiplex resource, the following permissions are required: + +### Read +
+medialive:DescribeMultiplex
+ +### Update +
+medialive:UpdateMultiplex,
+medialive:DescribeMultiplex,
+medialive:CreateTags,
+medialive:DeleteTags
+ +### Delete +
+medialive:DeleteMultiplex,
+medialive:DescribeMultiplex
+ + +## Example +```sql +SELECT +region, +arn, +availability_zones, +destinations, +id, +multiplex_settings, +name, +pipelines_running_count, +program_count, +state, +tags +FROM awscc.medialive.multiplex +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md b/docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md new file mode 100644 index 0000000000..466562bbad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md @@ -0,0 +1,60 @@ +--- +title: multiplexes +hide_title: false +hide_table_of_contents: false +keywords: + - multiplexes + - 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 +--- +Retrieves a list of multiplexes in a region + +## Overview + + + + + +
Namemultiplexes
TypeResource
Descriptionmultiplexes
Idawscc.medialive.multiplexes
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique id of the multiplex.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multiplexes resource, the following permissions are required: + +### Create +
+medialive:CreateMultiplex,
+medialive:DescribeMultiplex,
+medialive:CreateTags
+ +### List +
+medialive:ListMultiplexes
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.medialive.multiplexes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md b/docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md new file mode 100644 index 0000000000..a9fb4d6b8d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md @@ -0,0 +1,78 @@ +--- +title: multiplexprogram +hide_title: false +hide_table_of_contents: false +keywords: + - multiplexprogram + - 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 +--- +Gets an individual multiplexprogram resource + +## Overview + + + + + +
Namemultiplexprogram
TypeResource
Descriptionmultiplexprogram
Idawscc.medialive.multiplexprogram
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
channel_idstringThe MediaLive channel associated with the program.
multiplex_idstringThe ID of the multiplex that the program belongs to.
multiplex_program_settingsobjectThe settings for this multiplex program.
preferred_channel_pipelinestringThe settings for this multiplex program.
packet_identifiers_mapobjectThe packet identifier map for this multiplex program.
pipeline_detailsarrayContains 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.
program_namestringThe name of the multiplex program.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multiplexprogram resource, the following permissions are required: + +### Read +
+medialive:DescribeMultiplexProgram
+ +### Update +
+medialive:UpdateMultiplexProgram,
+medialive:DescribeMultiplexProgram
+ +### Delete +
+medialive:DeleteMultiplexProgram,
+medialive:DescribeMultiplexProgram
+ + +## Example +```sql +SELECT +region, +channel_id, +multiplex_id, +multiplex_program_settings, +preferred_channel_pipeline, +packet_identifiers_map, +pipeline_details, +program_name +FROM awscc.medialive.multiplexprogram +WHERE region = 'us-east-1' +AND data__Identifier = '<ProgramName>' +AND data__Identifier = '<MultiplexId>' +``` diff --git a/docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md b/docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md new file mode 100644 index 0000000000..f026bfd3fa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md @@ -0,0 +1,61 @@ +--- +title: multiplexprograms +hide_title: false +hide_table_of_contents: false +keywords: + - multiplexprograms + - 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 +--- +Retrieves a list of multiplexprograms in a region + +## Overview + + + + + +
Namemultiplexprograms
TypeResource
Descriptionmultiplexprograms
Idawscc.medialive.multiplexprograms
+ +## Fields + + + + + + +
NameDatatypeDescription
program_namestringThe name of the multiplex program.
multiplex_idstringThe ID of the multiplex that the program belongs to.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multiplexprograms resource, the following permissions are required: + +### Create +
+medialive:CreateMultiplexProgram,
+medialive:DescribeMultiplexProgram
+ +### List +
+medialive:ListMultiplexPrograms
+ + +## Example +```sql +SELECT +region, +program_name, +multiplex_id +FROM awscc.medialive.multiplexprograms +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/asset/index.md b/docs/awscc-docs/providers/awscc/mediapackage/asset/index.md new file mode 100644 index 0000000000..b43a65443b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/asset/index.md @@ -0,0 +1,76 @@ +--- +title: asset +hide_title: false +hide_table_of_contents: false +keywords: + - asset + - 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 +--- +Gets an individual asset resource + +## Overview + + + + + +
Nameasset
TypeResource
Descriptionasset
Idawscc.mediapackage.asset
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the Asset.
created_atstringThe time the Asset was initially submitted for Ingest.
egress_endpointsarrayThe list of egress endpoints available for the Asset.
idstringThe unique identifier for the Asset.
packaging_group_idstringThe ID of the PackagingGroup for the Asset.
resource_idstringThe resource ID to include in SPEKE key requests.
source_arnstringARN of the source object in S3.
source_role_arnstringThe IAM role_arn used to access the source S3 bucket.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the asset resource, the following permissions are required: + +### Read +
+mediapackage-vod:DescribeAsset
+ +### Delete +
+mediapackage-vod:DescribeAsset,
+mediapackage-vod:DeleteAsset
+ + +## Example +```sql +SELECT +region, +arn, +created_at, +egress_endpoints, +id, +packaging_group_id, +resource_id, +source_arn, +source_role_arn, +tags +FROM awscc.mediapackage.asset +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/assets/index.md b/docs/awscc-docs/providers/awscc/mediapackage/assets/index.md new file mode 100644 index 0000000000..99110a42f4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/assets/index.md @@ -0,0 +1,62 @@ +--- +title: assets +hide_title: false +hide_table_of_contents: false +keywords: + - assets + - 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 +--- +Retrieves a list of assets in a region + +## Overview + + + + + +
Nameassets
TypeResource
Descriptionassets
Idawscc.mediapackage.assets
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier for the Asset.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assets resource, the following permissions are required: + +### Create +
+mediapackage-vod:CreateAsset,
+mediapackage-vod:DescribeAsset,
+mediapackage-vod:TagResource,
+iam:PassRole
+ +### List +
+mediapackage-vod:ListAssets,
+mediapackage-vod:DescribePackagingGroup
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.mediapackage.assets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/channel/index.md b/docs/awscc-docs/providers/awscc/mediapackage/channel/index.md new file mode 100644 index 0000000000..4ae5d7d12d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/channel/index.md @@ -0,0 +1,77 @@ +--- +title: channel +hide_title: false +hide_table_of_contents: false +keywords: + - channel + - 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 +--- +Gets an individual channel resource + +## Overview + + + + + +
Namechannel
TypeResource
Descriptionchannel
Idawscc.mediapackage.channel
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) assigned to the Channel.
idstringThe ID of the Channel.
descriptionstringA short text description of the Channel.
hls_ingestobjectAn HTTP Live Streaming (HLS) ingest resource configuration.
tagsarrayA collection of tags associated with a resource
egress_access_logsobjectThe configuration parameters for egress access logging.
ingress_access_logsobjectThe configuration parameters for egress access logging.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +
+mediapackage:DescribeChannel
+ +### Update +
+mediapackage:UpdateChannel,
+mediapackage:ConfigureLogs,
+iam:CreateServiceLinkedRole
+ +### Delete +
+mediapackage:DeleteChannel
+ + +## Example +```sql +SELECT +region, +arn, +id, +description, +hls_ingest, +tags, +egress_access_logs, +ingress_access_logs +FROM awscc.mediapackage.channel +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/channels/index.md b/docs/awscc-docs/providers/awscc/mediapackage/channels/index.md new file mode 100644 index 0000000000..31556dc629 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/channels/index.md @@ -0,0 +1,63 @@ +--- +title: channels +hide_title: false +hide_table_of_contents: false +keywords: + - channels + - 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 +--- +Retrieves a list of channels in a region + +## Overview + + + + + +
Namechannels
TypeResource
Descriptionchannels
Idawscc.mediapackage.channels
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the Channel.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +
+mediapackage:CreateChannel,
+mediapackage:DescribeChannel,
+mediapackage:UpdateChannel,
+mediapackage:TagResource,
+mediapackage:ConfigureLogs,
+iam:CreateServiceLinkedRole
+ +### List +
+mediapackage:ListChannels
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.mediapackage.channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/index.md b/docs/awscc-docs/providers/awscc/mediapackage/index.md new file mode 100644 index 0000000000..babb4d9694 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/index.md @@ -0,0 +1,47 @@ +--- +title: mediapackage +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The mediapackage service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+asset
+assets
+channel
+channels
+origin_endpoint +
+
+origin_endpoints
+packaging_configuration
+packaging_configurations
+packaging_group
+packaging_groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoint/index.md b/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoint/index.md new file mode 100644 index 0000000000..e57ac128c0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoint/index.md @@ -0,0 +1,94 @@ +--- +title: origin_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint + - 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 +--- +Gets an individual origin_endpoint resource + +## Overview + + + + + +
Nameorigin_endpoint
TypeResource
Descriptionorigin_endpoint
Idawscc.mediapackage.origin_endpoint
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) assigned to the OriginEndpoint.
urlstringThe URL of the packaged OriginEndpoint for consumption.
idstringThe ID of the OriginEndpoint.
channel_idstringThe ID of the Channel the OriginEndpoint is associated with.
descriptionstringA short text description of the OriginEndpoint.
whitelistarrayA list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
startover_window_secondsintegerMaximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
time_delay_secondsintegerAmount 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.
manifest_namestringA short string appended to the end of the OriginEndpoint URL.
originationstringControl 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
authorizationobject
hls_packageobject
dash_packageobject
mss_packageobject
cmaf_packageobject
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_endpoint resource, the following permissions are required: + +### Read +
+mediapackage:DescribeOriginEndpoint
+ +### Update +
+mediapackage:UpdateOriginEndpoint,
+iam:PassRole
+ +### Delete +
+mediapackage:DeleteOriginEndpoint
+ + +## Example +```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, +tags +FROM awscc.mediapackage.origin_endpoint +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md b/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md new file mode 100644 index 0000000000..2bea8993dc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md @@ -0,0 +1,63 @@ +--- +title: origin_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoints + - 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 +--- +Retrieves a list of origin_endpoints in a region + +## Overview + + + + + +
Nameorigin_endpoints
TypeResource
Descriptionorigin_endpoints
Idawscc.mediapackage.origin_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the OriginEndpoint.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_endpoints resource, the following permissions are required: + +### Create +
+mediapackage:CreateOriginEndpoint,
+mediapackage:DescribeOriginEndpoint,
+mediapackage:DescribeChannel,
+mediapackage:TagResource,
+iam:PassRole,
+acm:DescribeCertificate
+ +### List +
+mediapackage:ListOriginEndpoints
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.mediapackage.origin_endpoints +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md new file mode 100644 index 0000000000..b0b7eab5e2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md @@ -0,0 +1,74 @@ +--- +title: packaging_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_configuration + - 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 +--- +Gets an individual packaging_configuration resource + +## Overview + + + + + +
Namepackaging_configuration
TypeResource
Descriptionpackaging_configuration
Idawscc.mediapackage.packaging_configuration
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingConfiguration.
packaging_group_idstringThe ID of a PackagingGroup.
arnstringThe ARN of the PackagingConfiguration.
cmaf_packageobjectA CMAF packaging configuration.
dash_packageobjectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
hls_packageobjectAn HTTP Live Streaming (HLS) packaging configuration.
mss_packageobjectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the packaging_configuration resource, the following permissions are required: + +### Read +
+mediapackage-vod:DescribePackagingConfiguration
+ +### Delete +
+mediapackage-vod:DescribePackagingConfiguration,
+mediapackage-vod:DeletePackagingConfiguration
+ + +## Example +```sql +SELECT +region, +id, +packaging_group_id, +arn, +cmaf_package, +dash_package, +hls_package, +mss_package, +tags +FROM awscc.mediapackage.packaging_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md new file mode 100644 index 0000000000..1df8fff1b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md @@ -0,0 +1,62 @@ +--- +title: packaging_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_configurations + - 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 +--- +Retrieves a list of packaging_configurations in a region + +## Overview + + + + + +
Namepackaging_configurations
TypeResource
Descriptionpackaging_configurations
Idawscc.mediapackage.packaging_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingConfiguration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the packaging_configurations resource, the following permissions are required: + +### Create +
+mediapackage-vod:CreatePackagingConfiguration,
+mediapackage-vod:DescribePackagingConfiguration,
+mediapackage-vod:TagResource,
+iam:PassRole
+ +### List +
+mediapackage-vod:ListPackagingConfigurations,
+mediapackage-vod:DescribePackagingGroup
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.mediapackage.packaging_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md new file mode 100644 index 0000000000..f5b5ea3747 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md @@ -0,0 +1,79 @@ +--- +title: packaging_group +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_group + - 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 +--- +Gets an individual packaging_group resource + +## Overview + + + + + +
Namepackaging_group
TypeResource
Descriptionpackaging_group
Idawscc.mediapackage.packaging_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingGroup.
arnstringThe ARN of the PackagingGroup.
domain_namestringThe fully qualified domain name for Assets in the PackagingGroup.
authorizationobjectCDN Authorization
tagsarrayA collection of tags associated with a resource
egress_access_logsobjectThe configuration parameters for egress access logging.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the packaging_group resource, the following permissions are required: + +### Read +
+mediapackage-vod:DescribePackagingGroup
+ +### Update +
+mediapackage-vod:DescribePackagingGroup,
+mediapackage-vod:UpdatePackagingGroup,
+mediapackage-vod:ConfigureLogs,
+mediapackage-vod:TagResource,
+iam:PassRole,
+iam:CreateServiceLinkedRole
+ +### Delete +
+mediapackage-vod:DescribePackagingGroup,
+mediapackage-vod:DeletePackagingGroup
+ + +## Example +```sql +SELECT +region, +id, +arn, +domain_name, +authorization, +tags, +egress_access_logs +FROM awscc.mediapackage.packaging_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md new file mode 100644 index 0000000000..0ab48342cd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md @@ -0,0 +1,63 @@ +--- +title: packaging_groups +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_groups + - 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 +--- +Retrieves a list of packaging_groups in a region + +## Overview + + + + + +
Namepackaging_groups
TypeResource
Descriptionpackaging_groups
Idawscc.mediapackage.packaging_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingGroup.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the packaging_groups resource, the following permissions are required: + +### Create +
+mediapackage-vod:CreatePackagingGroup,
+mediapackage-vod:DescribePackagingGroup,
+mediapackage-vod:TagResource,
+mediapackage-vod:ConfigureLogs,
+iam:PassRole,
+iam:CreateServiceLinkedRole
+ +### List +
+mediapackage-vod:ListPackagingGroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.mediapackage.packaging_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md new file mode 100644 index 0000000000..a30cc0b421 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md @@ -0,0 +1,81 @@ +--- +title: channel +hide_title: false +hide_table_of_contents: false +keywords: + - channel + - 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 +--- +Gets an individual channel resource + +## Overview + + + + + +
Namechannel
TypeResource
Descriptionchannel
Idawscc.mediapackagev2.channel
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_namestring
channel_namestring
created_atstring<p>The date and time the channel was created.</p>
descriptionstring<p>Enter any descriptive text that helps you to identify the channel.</p>
ingest_endpointsarray<p>The list of ingest endpoints.</p>
modified_atstring<p>The date and time the channel was modified.</p>
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +
+mediapackagev2:GetChannel
+ +### Update +
+mediapackagev2:TagResource,
+mediapackagev2:UntagResource,
+mediapackagev2:ListTagsForResource,
+mediapackagev2:UpdateChannel
+ +### Delete +
+mediapackagev2:GetChannel,
+mediapackagev2:DeleteChannel
+ + +## Example +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +created_at, +description, +ingest_endpoints, +modified_at, +tags +FROM awscc.mediapackagev2.channel +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md new file mode 100644 index 0000000000..ad90633865 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md @@ -0,0 +1,79 @@ +--- +title: channel_group +hide_title: false +hide_table_of_contents: false +keywords: + - channel_group + - 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 +--- +Gets an individual channel_group resource + +## Overview + + + + + +
Namechannel_group
TypeResource
Descriptionchannel_group
Idawscc.mediapackagev2.channel_group
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_namestring
created_atstring<p>The date and time the channel group was created.</p>
descriptionstring<p>Enter any descriptive text that helps you to identify the channel group.</p>
egress_domainstring<p>The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.</p>
modified_atstring<p>The date and time the channel group was modified.</p>
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel_group resource, the following permissions are required: + +### Read +
+mediapackagev2:GetChannelGroup
+ +### Update +
+mediapackagev2:TagResource,
+mediapackagev2:UntagResource,
+mediapackagev2:ListTagsForResource,
+mediapackagev2:UpdateChannelGroup
+ +### Delete +
+mediapackagev2:GetChannelGroup,
+mediapackagev2:DeleteChannelGroup
+ + +## Example +```sql +SELECT +region, +arn, +channel_group_name, +created_at, +description, +egress_domain, +modified_at, +tags +FROM awscc.mediapackagev2.channel_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md new file mode 100644 index 0000000000..b9eb3e14e7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md @@ -0,0 +1,59 @@ +--- +title: channel_groups +hide_title: false +hide_table_of_contents: false +keywords: + - channel_groups + - 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 +--- +Retrieves a list of channel_groups in a region + +## Overview + + + + + +
Namechannel_groups
TypeResource
Descriptionchannel_groups
Idawscc.mediapackagev2.channel_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel_groups resource, the following permissions are required: + +### Create +
+mediapackagev2:TagResource,
+mediapackagev2:CreateChannelGroup
+ +### List +
+mediapackagev2:ListChannelGroups
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.mediapackagev2.channel_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policies/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policies/index.md new file mode 100644 index 0000000000..7893e9b01d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policies/index.md @@ -0,0 +1,57 @@ +--- +title: channel_policies +hide_title: false +hide_table_of_contents: false +keywords: + - channel_policies + - 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 +--- +Retrieves a list of channel_policies in a region + +## Overview + + + + + +
Namechannel_policies
TypeResource
Descriptionchannel_policies
Idawscc.mediapackagev2.channel_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel_policies resource, the following permissions are required: + +### Create +
+mediapackagev2:GetChannelPolicy,
+mediapackagev2:PutChannelPolicy
+ + +## Example +```sql +SELECT +region, +channel_group_name, +channel_name +FROM awscc.mediapackagev2.channel_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md new file mode 100644 index 0000000000..11dca18741 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md @@ -0,0 +1,70 @@ +--- +title: channel_policy +hide_title: false +hide_table_of_contents: false +keywords: + - channel_policy + - 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 +--- +Gets an individual channel_policy resource + +## Overview + + + + + +
Namechannel_policy
TypeResource
Descriptionchannel_policy
Idawscc.mediapackagev2.channel_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
policyobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel_policy resource, the following permissions are required: + +### Read +
+mediapackagev2:GetChannelPolicy
+ +### Update +
+mediapackagev2:GetChannelPolicy,
+mediapackagev2:PutChannelPolicy
+ +### Delete +
+mediapackagev2:GetChannelPolicy,
+mediapackagev2:DeleteChannelPolicy
+ + +## Example +```sql +SELECT +region, +channel_group_name, +channel_name, +policy +FROM awscc.mediapackagev2.channel_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ChannelGroupName>' +AND data__Identifier = '<ChannelName>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md new file mode 100644 index 0000000000..c5dd6315f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md @@ -0,0 +1,59 @@ +--- +title: channels +hide_title: false +hide_table_of_contents: false +keywords: + - channels + - 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 +--- +Retrieves a list of channels in a region + +## Overview + + + + + +
Namechannels
TypeResource
Descriptionchannels
Idawscc.mediapackagev2.channels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +
+mediapackagev2:TagResource,
+mediapackagev2:CreateChannel
+ +### List +
+mediapackagev2:ListChannels
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.mediapackagev2.channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/index.md new file mode 100644 index 0000000000..e5dcde4afd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/index.md @@ -0,0 +1,47 @@ +--- +title: mediapackagev2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The mediapackagev2 service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+channel
+channel_group
+channel_groups
+channel_policies
+channel_policy +
+
+channels
+origin_endpoint
+origin_endpoint_policies
+origin_endpoint_policy
+origin_endpoints +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint/index.md new file mode 100644 index 0000000000..8315c259b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint/index.md @@ -0,0 +1,92 @@ +--- +title: origin_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint + - 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 +--- +Gets an individual origin_endpoint resource + +## Overview + + + + + +
Nameorigin_endpoint
TypeResource
Descriptionorigin_endpoint
Idawscc.mediapackagev2.origin_endpoint
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_namestring
channel_namestring
container_typestring
created_atstring<p>The date and time the origin endpoint was created.</p>
descriptionstring<p>Enter any descriptive text that helps you to identify the origin endpoint.</p>
hls_manifestsarray<p>An HTTP live streaming (HLS) manifest configuration.</p>
low_latency_hls_manifestsarray<p>A low-latency HLS manifest configuration.</p>
modified_atstring<p>The date and time the origin endpoint was modified.</p>
origin_endpoint_namestring
segmentobject
startover_window_secondsinteger<p>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).</p>
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_endpoint resource, the following permissions are required: + +### Read +
+mediapackagev2:GetOriginEndpoint
+ +### Update +
+mediapackagev2:TagResource,
+mediapackagev2:UntagResource,
+mediapackagev2:ListTagsForResource,
+mediapackagev2:UpdateOriginEndpoint,
+iam:PassRole
+ +### Delete +
+mediapackagev2:GetOriginEndpoint,
+mediapackagev2:DeleteOriginEndpoint
+ + +## Example +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +container_type, +created_at, +description, +hls_manifests, +low_latency_hls_manifests, +modified_at, +origin_endpoint_name, +segment, +startover_window_seconds, +tags +FROM awscc.mediapackagev2.origin_endpoint +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policies/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policies/index.md new file mode 100644 index 0000000000..ad3b5043dd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policies/index.md @@ -0,0 +1,59 @@ +--- +title: origin_endpoint_policies +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint_policies + - 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 +--- +Retrieves a list of origin_endpoint_policies in a region + +## Overview + + + + + +
Nameorigin_endpoint_policies
TypeResource
Descriptionorigin_endpoint_policies
Idawscc.mediapackagev2.origin_endpoint_policies
+ +## Fields + + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
origin_endpoint_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_endpoint_policies resource, the following permissions are required: + +### Create +
+mediapackagev2:GetOriginEndpointPolicy,
+mediapackagev2:PutOriginEndpointPolicy
+ + +## Example +```sql +SELECT +region, +channel_group_name, +channel_name, +origin_endpoint_name +FROM awscc.mediapackagev2.origin_endpoint_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policy/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policy/index.md new file mode 100644 index 0000000000..2ef412178e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policy/index.md @@ -0,0 +1,73 @@ +--- +title: origin_endpoint_policy +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint_policy + - 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 +--- +Gets an individual origin_endpoint_policy resource + +## Overview + + + + + +
Nameorigin_endpoint_policy
TypeResource
Descriptionorigin_endpoint_policy
Idawscc.mediapackagev2.origin_endpoint_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
origin_endpoint_namestring
policyobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_endpoint_policy resource, the following permissions are required: + +### Read +
+mediapackagev2:GetOriginEndpointPolicy
+ +### Update +
+mediapackagev2:GetOriginEndpointPolicy,
+mediapackagev2:PutOriginEndpointPolicy
+ +### Delete +
+mediapackagev2:GetOriginEndpointPolicy,
+mediapackagev2:DeleteOriginEndpointPolicy
+ + +## Example +```sql +SELECT +region, +channel_group_name, +channel_name, +origin_endpoint_name, +policy +FROM awscc.mediapackagev2.origin_endpoint_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ChannelGroupName>' +AND data__Identifier = '<ChannelName>' +AND data__Identifier = '<OriginEndpointName>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md new file mode 100644 index 0000000000..dbe9b24828 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md @@ -0,0 +1,60 @@ +--- +title: origin_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoints + - 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 +--- +Retrieves a list of origin_endpoints in a region + +## Overview + + + + + +
Nameorigin_endpoints
TypeResource
Descriptionorigin_endpoints
Idawscc.mediapackagev2.origin_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the origin_endpoints resource, the following permissions are required: + +### Create +
+mediapackagev2:TagResource,
+mediapackagev2:CreateOriginEndpoint,
+iam:PassRole
+ +### List +
+mediapackagev2:ListOriginEndpoints
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.mediapackagev2.origin_endpoints +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/channel/index.md b/docs/awscc-docs/providers/awscc/mediatailor/channel/index.md new file mode 100644 index 0000000000..0d03e5a4ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/channel/index.md @@ -0,0 +1,85 @@ +--- +title: channel +hide_title: false +hide_table_of_contents: false +keywords: + - channel + - 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 +--- +Gets an individual channel resource + +## Overview + + + + + +
Namechannel
TypeResource
Descriptionchannel
Idawscc.mediatailor.channel
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The ARN of the channel.</p>
channel_namestring
filler_slateobject
log_configurationobject
outputsarray<p>The channel's output properties.</p>
playback_modestring
tagsarrayThe tags to assign to the channel.
tierstring
time_shift_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +
+mediatailor:DescribeChannel
+ +### Update +
+mediatailor:UpdateChannel,
+mediatailor:TagResource,
+mediatailor:UntagResource,
+iam:CreateServiceLinkedRole,
+mediatailor:ConfigureLogsForChannel,
+mediatailor:DescribeChannel
+ +### Delete +
+mediatailor:DeleteChannel,
+mediatailor:DescribeChannel
+ + +## Example +```sql +SELECT +region, +arn, +channel_name, +filler_slate, +log_configuration, +outputs, +playback_mode, +tags, +tier, +time_shift_configuration +FROM awscc.mediatailor.channel +WHERE region = 'us-east-1' +AND data__Identifier = '<ChannelName>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/channel_policies/index.md b/docs/awscc-docs/providers/awscc/mediatailor/channel_policies/index.md new file mode 100644 index 0000000000..7751041d96 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/channel_policies/index.md @@ -0,0 +1,55 @@ +--- +title: channel_policies +hide_title: false +hide_table_of_contents: false +keywords: + - channel_policies + - 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 +--- +Retrieves a list of channel_policies in a region + +## Overview + + + + + +
Namechannel_policies
TypeResource
Descriptionchannel_policies
Idawscc.mediatailor.channel_policies
+ +## Fields + + + + + +
NameDatatypeDescription
channel_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel_policies resource, the following permissions are required: + +### Create +
+mediatailor:PutChannelPolicy,
+mediatailor:GetChannelPolicy
+ + +## Example +```sql +SELECT +region, +channel_name +FROM awscc.mediatailor.channel_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md b/docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md new file mode 100644 index 0000000000..8c2c25b613 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md @@ -0,0 +1,67 @@ +--- +title: channel_policy +hide_title: false +hide_table_of_contents: false +keywords: + - channel_policy + - 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 +--- +Gets an individual channel_policy resource + +## Overview + + + + + +
Namechannel_policy
TypeResource
Descriptionchannel_policy
Idawscc.mediatailor.channel_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
channel_namestring
policyobject<p>The IAM policy for the channel. IAM policies are used to control access to your channel.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channel_policy resource, the following permissions are required: + +### Read +
+mediatailor:GetChannelPolicy
+ +### Update +
+mediatailor:PutChannelPolicy,
+mediatailor:GetChannelPolicy
+ +### Delete +
+mediatailor:DeleteChannelPolicy,
+mediatailor:GetChannelPolicy
+ + +## Example +```sql +SELECT +region, +channel_name, +policy +FROM awscc.mediatailor.channel_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ChannelName>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/channels/index.md b/docs/awscc-docs/providers/awscc/mediatailor/channels/index.md new file mode 100644 index 0000000000..97062f466b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/channels/index.md @@ -0,0 +1,62 @@ +--- +title: channels +hide_title: false +hide_table_of_contents: false +keywords: + - channels + - 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 +--- +Retrieves a list of channels in a region + +## Overview + + + + + +
Namechannels
TypeResource
Descriptionchannels
Idawscc.mediatailor.channels
+ +## Fields + + + + + +
NameDatatypeDescription
channel_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +
+mediatailor:CreateChannel,
+mediatailor:TagResource,
+mediatailor:ConfigureLogsForChannel,
+iam:CreateServiceLinkedRole,
+mediatailor:DescribeChannel
+ +### List +
+mediatailor:ListChannels
+ + +## Example +```sql +SELECT +region, +channel_name +FROM awscc.mediatailor.channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/index.md b/docs/awscc-docs/providers/awscc/mediatailor/index.md new file mode 100644 index 0000000000..6e850cc772 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/index.md @@ -0,0 +1,49 @@ +--- +title: mediatailor +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The mediatailor service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+channel
+channel_policies
+channel_policy
+channels
+live_source
+live_sources +
+
+playback_configuration
+playback_configurations
+source_location
+source_locations
+vod_source
+vod_sources +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/mediatailor/live_source/index.md b/docs/awscc-docs/providers/awscc/mediatailor/live_source/index.md new file mode 100644 index 0000000000..1ea7c44090 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/live_source/index.md @@ -0,0 +1,76 @@ +--- +title: live_source +hide_title: false +hide_table_of_contents: false +keywords: + - live_source + - 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 +--- +Gets an individual live_source resource + +## Overview + + + + + +
Namelive_source
TypeResource
Descriptionlive_source
Idawscc.mediatailor.live_source
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The ARN of the live source.</p>
http_package_configurationsarray<p>A list of HTTP package configuration parameters for this live source.</p>
live_source_namestring
source_location_namestring
tagsarrayThe tags to assign to the live source.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the live_source resource, the following permissions are required: + +### Read +
+mediatailor:DescribeLiveSource
+ +### Update +
+mediatailor:UpdateLiveSource,
+mediatailor:DescribeLiveSource,
+mediatailor:TagResource,
+mediatailor:UntagResource
+ +### Delete +
+mediatailor:DeleteLiveSource,
+mediatailor:DescribeLiveSource
+ + +## Example +```sql +SELECT +region, +arn, +http_package_configurations, +live_source_name, +source_location_name, +tags +FROM awscc.mediatailor.live_source +WHERE region = 'us-east-1' +AND data__Identifier = '<LiveSourceName>' +AND data__Identifier = '<SourceLocationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md b/docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md new file mode 100644 index 0000000000..c607b31af6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md @@ -0,0 +1,62 @@ +--- +title: live_sources +hide_title: false +hide_table_of_contents: false +keywords: + - live_sources + - 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 +--- +Retrieves a list of live_sources in a region + +## Overview + + + + + +
Namelive_sources
TypeResource
Descriptionlive_sources
Idawscc.mediatailor.live_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
live_source_namestring
source_location_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the live_sources resource, the following permissions are required: + +### Create +
+mediatailor:CreateLiveSource,
+mediatailor:DescribeLiveSource,
+mediatailor:TagResource
+ +### List +
+mediatailor:ListLiveSources
+ + +## Example +```sql +SELECT +region, +live_source_name, +source_location_name +FROM awscc.mediatailor.live_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md b/docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md new file mode 100644 index 0000000000..430eaff891 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md @@ -0,0 +1,101 @@ +--- +title: playback_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - playback_configuration + - 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 +--- +Gets an individual playback_configuration resource + +## Overview + + + + + +
Nameplayback_configuration
TypeResource
Descriptionplayback_configuration
Idawscc.mediatailor.playback_configuration
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ad_decision_server_urlstringThe 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.
avail_suppressionobjectThe 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).
bumperobjectThe 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).
cdn_configurationobjectThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configuration_aliasesundefinedThe player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
dash_configurationobjectThe configuration for DASH content.
live_pre_roll_configurationobjectThe configuration for pre-roll ad insertion.
manifest_processing_rulesobjectThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
namestringThe identifier for the playback configuration.
personalization_threshold_secondsintegerDefines 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).
session_initialization_endpoint_prefixstringThe URL that the player uses to initialize a session that uses client-side reporting.
hls_configurationobjectThe configuration for HLS content.
playback_configuration_arnstringThe Amazon Resource Name (ARN) for the playback configuration.
playback_endpoint_prefixstringThe URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
slate_ad_urlstringThe 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.
tagsarrayThe tags to assign to the playback configuration.
transcode_profile_namestringThe 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.
video_content_source_urlstringThe URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the playback_configuration resource, the following permissions are required: + +### Read +
+mediatailor:GetPlaybackConfiguration
+ +### Update +
+mediatailor:PutPlaybackConfiguration,
+mediatailor:ConfigureLogsForPlaybackConfiguration,
+iam:CreateServiceLinkedRole,
+mediatailor:UntagResource,
+mediatailor:TagResource
+ +### Delete +
+mediatailor:DeletePlaybackConfiguration
+ + +## Example +```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, +tags, +transcode_profile_name, +video_content_source_url +FROM awscc.mediatailor.playback_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md b/docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md new file mode 100644 index 0000000000..00991eb5ec --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md @@ -0,0 +1,62 @@ +--- +title: playback_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - playback_configurations + - 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 +--- +Retrieves a list of playback_configurations in a region + +## Overview + + + + + +
Nameplayback_configurations
TypeResource
Descriptionplayback_configurations
Idawscc.mediatailor.playback_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe identifier for the playback configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the playback_configurations resource, the following permissions are required: + +### Create +
+mediatailor:PutPlaybackConfiguration,
+mediatailor:ConfigureLogsForPlaybackConfiguration,
+iam:CreateServiceLinkedRole,
+mediatailor:UntagResource,
+mediatailor:TagResource
+ +### List +
+mediatailor:ListPlaybackConfigurations
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.mediatailor.playback_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md b/docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md new file mode 100644 index 0000000000..f0126873cb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md @@ -0,0 +1,82 @@ +--- +title: source_location +hide_title: false +hide_table_of_contents: false +keywords: + - source_location + - 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 +--- +Gets an individual source_location resource + +## Overview + + + + + +
Namesource_location
TypeResource
Descriptionsource_location
Idawscc.mediatailor.source_location
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
access_configurationobject
arnstring<p>The ARN of the source location.</p>
default_segment_delivery_configurationobject
http_configurationobject
segment_delivery_configurationsarray<p>A list of the segment delivery configurations associated with this resource.</p>
source_location_namestring
tagsarrayThe tags to assign to the source location.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the source_location resource, the following permissions are required: + +### Read +
+mediatailor:DescribeSourceLocation
+ +### Update +
+mediatailor:DescribeSourceLocation,
+mediatailor:TagResource,
+mediatailor:UntagResource,
+mediatailor:UpdateSourceLocation,
+secretsmanager:DescribeSecret,
+secretsmanager:GetSecretValue,
+kms:CreateGrant
+ +### Delete +
+mediatailor:DeleteSourceLocation,
+mediatailor:DescribeSourceLocation
+ + +## Example +```sql +SELECT +region, +access_configuration, +arn, +default_segment_delivery_configuration, +http_configuration, +segment_delivery_configurations, +source_location_name, +tags +FROM awscc.mediatailor.source_location +WHERE region = 'us-east-1' +AND data__Identifier = '<SourceLocationName>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md b/docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md new file mode 100644 index 0000000000..e217b0645e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md @@ -0,0 +1,63 @@ +--- +title: source_locations +hide_title: false +hide_table_of_contents: false +keywords: + - source_locations + - 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 +--- +Retrieves a list of source_locations in a region + +## Overview + + + + + +
Namesource_locations
TypeResource
Descriptionsource_locations
Idawscc.mediatailor.source_locations
+ +## Fields + + + + + +
NameDatatypeDescription
source_location_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the source_locations resource, the following permissions are required: + +### Create +
+mediatailor:CreateSourceLocation,
+mediatailor:DescribeSourceLocation,
+mediatailor:TagResource,
+secretsmanager:DescribeSecret,
+secretsmanager:GetSecretValue,
+kms:CreateGrant
+ +### List +
+mediatailor:ListSourceLocations
+ + +## Example +```sql +SELECT +region, +source_location_name +FROM awscc.mediatailor.source_locations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md b/docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md new file mode 100644 index 0000000000..f349998e9d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md @@ -0,0 +1,76 @@ +--- +title: vod_source +hide_title: false +hide_table_of_contents: false +keywords: + - vod_source + - 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 +--- +Gets an individual vod_source resource + +## Overview + + + + + +
Namevod_source
TypeResource
Descriptionvod_source
Idawscc.mediatailor.vod_source
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The ARN of the VOD source.</p>
http_package_configurationsarray<p>A list of HTTP package configuration parameters for this VOD source.</p>
source_location_namestring
tagsarrayThe tags to assign to the VOD source.
vod_source_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vod_source resource, the following permissions are required: + +### Read +
+mediatailor:DescribeVodSource
+ +### Update +
+mediatailor:DescribeVodSource,
+mediatailor:TagResource,
+mediatailor:UntagResource,
+mediatailor:UpdateVodSource
+ +### Delete +
+mediatailor:DeleteVodSource,
+mediatailor:DescribeVodSource
+ + +## Example +```sql +SELECT +region, +arn, +http_package_configurations, +source_location_name, +tags, +vod_source_name +FROM awscc.mediatailor.vod_source +WHERE region = 'us-east-1' +AND data__Identifier = '<SourceLocationName>' +AND data__Identifier = '<VodSourceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md b/docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md new file mode 100644 index 0000000000..23a7f22ea9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md @@ -0,0 +1,62 @@ +--- +title: vod_sources +hide_title: false +hide_table_of_contents: false +keywords: + - vod_sources + - 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 +--- +Retrieves a list of vod_sources in a region + +## Overview + + + + + +
Namevod_sources
TypeResource
Descriptionvod_sources
Idawscc.mediatailor.vod_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
source_location_namestring
vod_source_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vod_sources resource, the following permissions are required: + +### Create +
+mediatailor:CreateVodSource,
+mediatailor:DescribeVodSource,
+mediatailor:TagResource
+ +### List +
+mediatailor:ListVodSources
+ + +## Example +```sql +SELECT +region, +source_location_name, +vod_source_name +FROM awscc.mediatailor.vod_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/acl/index.md b/docs/awscc-docs/providers/awscc/memorydb/acl/index.md new file mode 100644 index 0000000000..fe4a86a1f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/acl/index.md @@ -0,0 +1,78 @@ +--- +title: acl +hide_title: false +hide_table_of_contents: false +keywords: + - acl + - 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 +--- +Gets an individual acl resource + +## Overview + + + + + +
Nameacl
TypeResource
Descriptionacl
Idawscc.memorydb.acl
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
statusstringIndicates acl status. Can be "creating", "active", "modifying", "deleting".
a_cl_namestringThe name of the acl.
user_namesarrayList of users associated to this acl.
arnstringThe Amazon Resource Name (ARN) of the acl.
tagsarrayAn array of key-value pairs to apply to this cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the acl resource, the following permissions are required: + +### Read +
+memorydb:DescribeACLs,
+memorydb:ListTags
+ +### Update +
+memorydb:UpdateACL,
+memorydb:DescribeACLs,
+memorydb:ListTags,
+memorydb:TagResource,
+memorydb:UntagResource
+ +### Delete +
+memorydb:ModifyReplicationGroup,
+memorydb:DeleteACL,
+memorydb:DescribeACLs
+ + +## Example +```sql +SELECT +region, +status, +a_cl_name, +user_names, +arn, +tags +FROM awscc.memorydb.acl +WHERE region = 'us-east-1' +AND data__Identifier = '<ACLName>' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/acls/index.md b/docs/awscc-docs/providers/awscc/memorydb/acls/index.md new file mode 100644 index 0000000000..86410dfcf5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/acls/index.md @@ -0,0 +1,62 @@ +--- +title: acls +hide_title: false +hide_table_of_contents: false +keywords: + - acls + - 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 +--- +Retrieves a list of acls in a region + +## Overview + + + + + +
Nameacls
TypeResource
Descriptionacls
Idawscc.memorydb.acls
+ +## Fields + + + + + +
NameDatatypeDescription
a_cl_namestringThe name of the acl.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the acls resource, the following permissions are required: + +### Create +
+memorydb:CreateACL,
+memorydb:DescribeACLs,
+memorydb:TagResource,
+memorydb:ListTags
+ +### List +
+memorydb:DescribeACLs,
+memorydb:ListTags
+ + +## Example +```sql +SELECT +region, +a_cl_name +FROM awscc.memorydb.acls +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/cluster/index.md b/docs/awscc-docs/providers/awscc/memorydb/cluster/index.md new file mode 100644 index 0000000000..1fa32f5053 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/cluster/index.md @@ -0,0 +1,123 @@ +--- +title: cluster +hide_title: false +hide_table_of_contents: false +keywords: + - cluster + - 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 +--- +Gets an individual cluster resource + +## Overview + + + + + +
Namecluster
TypeResource
Descriptioncluster
Idawscc.memorydb.cluster
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_namestringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
descriptionstringAn optional description of the cluster.
statusstringThe status of the cluster. For example, Available, Updating, Creating.
node_typestringThe compute and memory capacity of the nodes in the cluster.
num_shardsintegerThe number of shards the cluster will contain.
num_replicas_per_shardintegerThe number of replicas to apply to each shard. The limit is 5.
subnet_group_namestringThe name of the subnet group to be used for the cluster.
security_group_idsarrayOne or more Amazon VPC security groups associated with this cluster.
maintenance_windowstringSpecifies 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.
parameter_group_namestringThe name of the parameter group associated with the cluster.
parameter_group_statusstringThe status of the parameter group used by the cluster.
portintegerThe port number on which each member of the cluster accepts connections.
snapshot_retention_limitintegerThe 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.
snapshot_windowstringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
a_cl_namestringThe name of the Access Control List to associate with the cluster.
sns_topic_arnstringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
sns_topic_statusstringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
t_ls_enabledbooleanA flag that enables in-transit encryption when set to true.<br/><br/>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.
data_tieringstringEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
kms_key_idstringThe ID of the KMS key used to encrypt the cluster.
snapshot_arnsarrayA 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.
snapshot_namestringThe 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.
final_snapshot_namestringThe 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.
a_rnstringThe Amazon Resource Name (ARN) of the cluster.
engine_versionstringThe Redis engine version used by the cluster.
cluster_endpointobjectThe cluster endpoint.
auto_minor_version_upgradebooleanA flag that enables automatic minor version upgrade when set to true.<br/><br/>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.
tagsarrayAn array of key-value pairs to apply to this cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +
+memorydb:DescribeClusters,
+memorydb:ListTags
+ +### Update +
+memorydb:UpdateCluster,
+memorydb:DescribeClusters,
+memorydb:ListTags,
+memorydb:TagResource,
+memorydb:UntagResource
+ +### Delete +
+memorydb:DeleteCluster,
+memorydb:DescribeClusters
+ + +## Example +```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, +a_cl_name, +sns_topic_arn, +sns_topic_status, +t_ls_enabled, +data_tiering, +kms_key_id, +snapshot_arns, +snapshot_name, +final_snapshot_name, +a_rn, +engine_version, +cluster_endpoint, +auto_minor_version_upgrade, +tags +FROM awscc.memorydb.cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterName>' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/clusters/index.md b/docs/awscc-docs/providers/awscc/memorydb/clusters/index.md new file mode 100644 index 0000000000..505d0aa79b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/clusters/index.md @@ -0,0 +1,60 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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 +--- +Retrieves a list of clusters in a region + +## Overview + + + + + +
Nameclusters
TypeResource
Descriptionclusters
Idawscc.memorydb.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_namestringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +
+memorydb:CreateCluster,
+memorydb:DescribeClusters,
+memorydb:ListTags
+ +### List +
+memorydb:DescribeClusters
+ + +## Example +```sql +SELECT +region, +cluster_name +FROM awscc.memorydb.clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/index.md b/docs/awscc-docs/providers/awscc/memorydb/index.md new file mode 100644 index 0000000000..c16d7ef263 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/index.md @@ -0,0 +1,47 @@ +--- +title: memorydb +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The memorydb service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+acl
+acls
+cluster
+clusters
+parameter_group +
+
+parameter_groups
+subnet_group
+subnet_groups
+user
+users +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/memorydb/parameter_group/index.md b/docs/awscc-docs/providers/awscc/memorydb/parameter_group/index.md new file mode 100644 index 0000000000..153cd2ba6f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/parameter_group/index.md @@ -0,0 +1,80 @@ +--- +title: parameter_group +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_group + - 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 +--- +Gets an individual parameter_group resource + +## Overview + + + + + +
Nameparameter_group
TypeResource
Descriptionparameter_group
Idawscc.memorydb.parameter_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the parameter group.
familystringThe name of the parameter group family that this parameter group is compatible with.
descriptionstringA description of the parameter group.
tagsarrayAn array of key-value pairs to apply to this parameter group.
parametersobjectAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
a_rnstringThe Amazon Resource Name (ARN) of the parameter group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the parameter_group resource, the following permissions are required: + +### Read +
+memorydb:DescribeParameterGroups,
+memorydb:ListTags
+ +### Update +
+memorydb:UpdateParameterGroup,
+memorydb:DescribeParameterGroups,
+memorydb:DescribeParameters,
+memorydb:DescribeClusters,
+memorydb:ListTags,
+memorydb:TagResource,
+memorydb:UntagResource
+ +### Delete +
+memorydb:DeleteParameterGroup
+ + +## Example +```sql +SELECT +region, +parameter_group_name, +family, +description, +tags, +parameters, +a_rn +FROM awscc.memorydb.parameter_group +WHERE region = 'us-east-1' +AND data__Identifier = '<ParameterGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md b/docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md new file mode 100644 index 0000000000..2f5629c6ef --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md @@ -0,0 +1,61 @@ +--- +title: parameter_groups +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_groups + - 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 +--- +Retrieves a list of parameter_groups in a region + +## Overview + + + + + +
Nameparameter_groups
TypeResource
Descriptionparameter_groups
Idawscc.memorydb.parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the parameter group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the parameter_groups resource, the following permissions are required: + +### Create +
+memorydb:CreateParameterGroup,
+memorydb:DescribeParameterGroups,
+memorydb:TagResource,
+memorydb:ListTags
+ +### List +
+memorydb:DescribeParameterGroups
+ + +## Example +```sql +SELECT +region, +parameter_group_name +FROM awscc.memorydb.parameter_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md b/docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md new file mode 100644 index 0000000000..5d04e65df9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md @@ -0,0 +1,77 @@ +--- +title: subnet_group +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_group + - 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 +--- +Gets an individual subnet_group resource + +## Overview + + + + + +
Namesubnet_group
TypeResource
Descriptionsubnet_group
Idawscc.memorydb.subnet_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
subnet_group_namestringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
descriptionstringAn optional description of the subnet group.
subnet_idsarrayA list of VPC subnet IDs for the subnet group.
tagsarrayAn array of key-value pairs to apply to this subnet group.
a_rnstringThe Amazon Resource Name (ARN) of the subnet group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subnet_group resource, the following permissions are required: + +### Read +
+memorydb:DescribeSubnetGroups,
+memorydb:ListTags
+ +### Update +
+memorydb:UpdateSubnetGroup,
+memorydb:DescribeSubnetGroups,
+memorydb:ListTags,
+memorydb:TagResource,
+memorydb:UntagResource
+ +### Delete +
+memorydb:DeleteSubnetGroup,
+memorydb:DescribeSubnetGroups
+ + +## Example +```sql +SELECT +region, +subnet_group_name, +description, +subnet_ids, +tags, +a_rn +FROM awscc.memorydb.subnet_group +WHERE region = 'us-east-1' +AND data__Identifier = '<SubnetGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md b/docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md new file mode 100644 index 0000000000..b18f7a811b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md @@ -0,0 +1,61 @@ +--- +title: subnet_groups +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_groups + - 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 +--- +Retrieves a list of subnet_groups in a region + +## Overview + + + + + +
Namesubnet_groups
TypeResource
Descriptionsubnet_groups
Idawscc.memorydb.subnet_groups
+ +## Fields + + + + + +
NameDatatypeDescription
subnet_group_namestringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the subnet_groups resource, the following permissions are required: + +### Create +
+memorydb:CreateSubnetGroup,
+memorydb:DescribeSubnetGroups,
+memorydb:TagResource,
+memorydb:ListTags
+ +### List +
+memorydb:DescribeSubnetGroups
+ + +## Example +```sql +SELECT +region, +subnet_group_name +FROM awscc.memorydb.subnet_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/user/index.md b/docs/awscc-docs/providers/awscc/memorydb/user/index.md new file mode 100644 index 0000000000..f024e80f95 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/user/index.md @@ -0,0 +1,79 @@ +--- +title: user +hide_title: false +hide_table_of_contents: false +keywords: + - user + - 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 +--- +Gets an individual user resource + +## Overview + + + + + +
Nameuser
TypeResource
Descriptionuser
Idawscc.memorydb.user
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
statusstringIndicates the user status. Can be "active", "modifying" or "deleting".
user_namestringThe name of the user.
access_stringstringAccess permissions string used for this user account.
authentication_modeobject
arnstringThe Amazon Resource Name (ARN) of the user account.
tagsarrayAn array of key-value pairs to apply to this user.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +
+memorydb:DescribeUsers,
+memorydb:ListTags
+ +### Update +
+memorydb:UpdateUser,
+memorydb:DescribeUsers,
+memorydb:ListTags,
+memorydb:TagResource,
+memorydb:UntagResource
+ +### Delete +
+memorydb:DeleteUser,
+memorydb:DescribeUsers
+ + +## Example +```sql +SELECT +region, +status, +user_name, +access_string, +authentication_mode, +arn, +tags +FROM awscc.memorydb.user +WHERE region = 'us-east-1' +AND data__Identifier = '<UserName>' +``` diff --git a/docs/awscc-docs/providers/awscc/memorydb/users/index.md b/docs/awscc-docs/providers/awscc/memorydb/users/index.md new file mode 100644 index 0000000000..9b3a02ff93 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/memorydb/users/index.md @@ -0,0 +1,62 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - 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 +--- +Retrieves a list of users in a region + +## Overview + + + + + +
Nameusers
TypeResource
Descriptionusers
Idawscc.memorydb.users
+ +## Fields + + + + + +
NameDatatypeDescription
user_namestringThe name of the user.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +
+memorydb:CreateUser,
+memorydb:DescribeUsers,
+memorydb:TagResource,
+memorydb:ListTags
+ +### List +
+memorydb:DescribeUsers,
+memorydb:ListTags
+ + +## Example +```sql +SELECT +region, +user_name +FROM awscc.memorydb.users +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/batch_scram_secret/index.md b/docs/awscc-docs/providers/awscc/msk/batch_scram_secret/index.md new file mode 100644 index 0000000000..53c3c2580a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/batch_scram_secret/index.md @@ -0,0 +1,76 @@ +--- +title: batch_scram_secret +hide_title: false +hide_table_of_contents: false +keywords: + - batch_scram_secret + - 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 +--- +Gets an individual batch_scram_secret resource + +## Overview + + + + + +
Namebatch_scram_secret
TypeResource
Descriptionbatch_scram_secret
Idawscc.msk.batch_scram_secret
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_arnstring
secret_arn_listarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the batch_scram_secret resource, the following permissions are required: + +### Delete +
+kafka:BatchDisassociateScramSecret,
+kafka:ListScramSecrets,
+kms:CreateGrant,
+kms:DescribeKey
+ +### Read +
+kafka:ListScramSecrets,
+kms:CreateGrant,
+kms:DescribeKey,
+secretsmanager:GetSecretValue
+ +### Update +
+kafka:BatchAssociateScramSecret,
+kafka:BatchDisassociateScramSecret,
+kafka:ListScramSecrets,
+kms:CreateGrant,
+kms:DescribeKey,
+secretsmanager:GetSecretValue
+ + +## Example +```sql +SELECT +region, +cluster_arn, +secret_arn_list +FROM awscc.msk.batch_scram_secret +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/batch_scram_secrets/index.md b/docs/awscc-docs/providers/awscc/msk/batch_scram_secrets/index.md new file mode 100644 index 0000000000..009f1d1cfe --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/batch_scram_secrets/index.md @@ -0,0 +1,65 @@ +--- +title: batch_scram_secrets +hide_title: false +hide_table_of_contents: false +keywords: + - batch_scram_secrets + - 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 +--- +Retrieves a list of batch_scram_secrets in a region + +## Overview + + + + + +
Namebatch_scram_secrets
TypeResource
Descriptionbatch_scram_secrets
Idawscc.msk.batch_scram_secrets
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the batch_scram_secrets resource, the following permissions are required: + +### Create +
+kafka:BatchAssociateScramSecret,
+kafka:ListScramSecrets,
+kms:CreateGrant,
+kms:DescribeKey,
+secretsmanager:GetSecretValue
+ +### List +
+kafka:ListScramSecrets,
+kms:CreateGrant,
+kms:DescribeKey,
+secretsmanager:GetSecretValue
+ + +## Example +```sql +SELECT +region, +cluster_arn +FROM awscc.msk.batch_scram_secrets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/cluster/index.md b/docs/awscc-docs/providers/awscc/msk/cluster/index.md new file mode 100644 index 0000000000..6b1c2fc5a7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/cluster/index.md @@ -0,0 +1,121 @@ +--- +title: cluster +hide_title: false +hide_table_of_contents: false +keywords: + - cluster + - 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 +--- +Gets an individual cluster resource + +## Overview + + + + + +
Namecluster
TypeResource
Descriptioncluster
Idawscc.msk.cluster
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
broker_node_group_infoobject
enhanced_monitoringstring
kafka_versionstring
number_of_broker_nodesinteger
encryption_infoobject
open_monitoringobject
cluster_namestring
arnstring
current_versionstringThe current version of the MSK cluster
client_authenticationobject
logging_infoobject
tagsobjectA key-value pair to associate with a resource.
configuration_infoobject
storage_modestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Update +
+kafka:UpdateMonitoring,
+kafka:UpdateClusterKafkaVersion,
+kafka:UpdateClusterConfiguration,
+kafka:UpdateBrokerType,
+kafka:UpdateBrokerCount,
+kafka:UpdateBrokerStorage,
+kafka:UpdateStorage,
+kafka:UpdateSecurity,
+kafka:UpdateConnectivity,
+kafka:DescribeCluster,
+kafka:DescribeClusterOperation,
+kafka:TagResource,
+kafka:UntagResource,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+ec2:DescribeSecurityGroups,
+iam:AttachRolePolicy,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy,
+kms:DescribeKey,
+kms:CreateGrant,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+s3:GetBucketPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+firehose:TagDeliveryStream,
+acm-pca:GetCertificateAuthorityCertificate
+ +### Delete +
+kafka:DeleteCluster,
+kafka:DescribeCluster
+ +### Read +
+kafka:DescribeCluster
+ + +## Example +```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, +tags, +configuration_info, +storage_mode +FROM awscc.msk.cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md b/docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md new file mode 100644 index 0000000000..8a80d86e85 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md @@ -0,0 +1,59 @@ +--- +title: cluster_policies +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_policies + - 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 +--- +Retrieves a list of cluster_policies in a region + +## Overview + + + + + +
Namecluster_policies
TypeResource
Descriptioncluster_policies
Idawscc.msk.cluster_policies
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstringThe arn of the cluster for the resource policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster_policies resource, the following permissions are required: + +### Create +
+kafka:PutClusterPolicy,
+kafka:GetClusterPolicy
+ +### List +
+kafka:GetClusterPolicy
+ + +## Example +```sql +SELECT +region, +cluster_arn +FROM awscc.msk.cluster_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md b/docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md new file mode 100644 index 0000000000..2f7e45ecee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md @@ -0,0 +1,69 @@ +--- +title: cluster_policy +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_policy + - 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 +--- +Gets an individual cluster_policy resource + +## Overview + + + + + +
Namecluster_policy
TypeResource
Descriptioncluster_policy
Idawscc.msk.cluster_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
policyobjectA policy document containing permissions to add to the specified cluster.
cluster_arnstringThe arn of the cluster for the resource policy.
current_versionstringThe current version of the policy attached to the specified cluster
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster_policy resource, the following permissions are required: + +### Read +
+kafka:GetClusterPolicy
+ +### Update +
+kafka:PutClusterPolicy,
+kafka:GetClusterPolicy
+ +### Delete +
+kafka:DeleteClusterPolicy,
+kafka:GetClusterPolicy
+ + +## Example +```sql +SELECT +region, +policy, +cluster_arn, +current_version +FROM awscc.msk.cluster_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/clusters/index.md b/docs/awscc-docs/providers/awscc/msk/clusters/index.md new file mode 100644 index 0000000000..0a0c0428ca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/clusters/index.md @@ -0,0 +1,80 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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 +--- +Retrieves a list of clusters in a region + +## Overview + + + + + +
Nameclusters
TypeResource
Descriptionclusters
Idawscc.msk.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+iam:AttachRolePolicy,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy,
+kms:CreateGrant,
+kms:DescribeKey,
+kafka:CreateCluster,
+kafka:DescribeCluster,
+kafka:TagResource,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+firehose:TagDeliveryStream,
+acm-pca:GetCertificateAuthorityCertificate
+ +### List +
+kafka:ListClusters
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.msk.clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/configuration/index.md b/docs/awscc-docs/providers/awscc/msk/configuration/index.md new file mode 100644 index 0000000000..7c95e550a0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/configuration/index.md @@ -0,0 +1,75 @@ +--- +title: configuration +hide_title: false +hide_table_of_contents: false +keywords: + - configuration + - 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 +--- +Gets an individual configuration resource + +## Overview + + + + + +
Nameconfiguration
TypeResource
Descriptionconfiguration
Idawscc.msk.configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestring
descriptionstring
server_propertiesstring
kafka_versions_listarray
arnstring
latest_revisionobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration resource, the following permissions are required: + +### Delete +
+kafka:DeleteConfiguration,
+kafka:DescribeConfiguration
+ +### Read +
+kafka:DescribeConfiguration
+ +### Update +
+kafka:UpdateConfiguration,
+kafka:DescribeConfiguration
+ + +## Example +```sql +SELECT +region, +name, +description, +server_properties, +kafka_versions_list, +arn, +latest_revision +FROM awscc.msk.configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/configurations/index.md b/docs/awscc-docs/providers/awscc/msk/configurations/index.md new file mode 100644 index 0000000000..9259d108ee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/configurations/index.md @@ -0,0 +1,59 @@ +--- +title: configurations +hide_title: false +hide_table_of_contents: false +keywords: + - configurations + - 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 +--- +Retrieves a list of configurations in a region + +## Overview + + + + + +
Nameconfigurations
TypeResource
Descriptionconfigurations
Idawscc.msk.configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configurations resource, the following permissions are required: + +### Create +
+kafka:CreateConfiguration,
+Kafka:DescribeConfiguration
+ +### List +
+kafka:ListConfigurations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.msk.configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/index.md b/docs/awscc-docs/providers/awscc/msk/index.md new file mode 100644 index 0000000000..7d99ea874b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/index.md @@ -0,0 +1,51 @@ +--- +title: msk +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The msk service documentation. + +:::info Service Summary + +
+
+total resources: 14
+total selectable resources: 14
+total methods: 14
+
+
+ +::: + +## Resources +
+
+batch_scram_secret
+batch_scram_secrets
+cluster
+cluster_policies
+cluster_policy
+clusters
+configuration +
+
+configurations
+replicator
+replicators
+serverless_cluster
+serverless_clusters
+vpc_connection
+vpc_connections +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/msk/replicator/index.md b/docs/awscc-docs/providers/awscc/msk/replicator/index.md new file mode 100644 index 0000000000..25b47a37b1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/replicator/index.md @@ -0,0 +1,85 @@ +--- +title: replicator +hide_title: false +hide_table_of_contents: false +keywords: + - replicator + - 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 +--- +Gets an individual replicator resource + +## Overview + + + + + +
Namereplicator
TypeResource
Descriptionreplicator
Idawscc.msk.replicator
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
replicator_arnstringAmazon Resource Name for the created replicator.
replicator_namestringThe name of the replicator.
current_versionstringThe current version of the MSK replicator.
descriptionstringA summary description of the replicator.
kafka_clustersarraySpecifies a list of Kafka clusters which are targets of the replicator.
replication_info_listarrayA list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
service_execution_role_arnstringThe Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replicator resource, the following permissions are required: + +### Read +
+kafka:DescribeReplicator,
+kafka:ListTagsForResource
+ +### Update +
+kafka:DescribeReplicator,
+kafka:ListTagsForResource,
+kafka:TagResource,
+kafka:UntagResource,
+kafka:UpdateReplicationInfo
+ +### Delete +
+kafka:DeleteReplicator,
+kafka:DescribeReplicator,
+kafka:ListTagsForResource,
+kafka:UntagResource
+ + +## Example +```sql +SELECT +region, +replicator_arn, +replicator_name, +current_version, +description, +kafka_clusters, +replication_info_list, +service_execution_role_arn, +tags +FROM awscc.msk.replicator +WHERE region = 'us-east-1' +AND data__Identifier = '<ReplicatorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/replicators/index.md b/docs/awscc-docs/providers/awscc/msk/replicators/index.md new file mode 100644 index 0000000000..5981644e9d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/replicators/index.md @@ -0,0 +1,70 @@ +--- +title: replicators +hide_title: false +hide_table_of_contents: false +keywords: + - replicators + - 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 +--- +Retrieves a list of replicators in a region + +## Overview + + + + + +
Namereplicators
TypeResource
Descriptionreplicators
Idawscc.msk.replicators
+ +## Fields + + + + + +
NameDatatypeDescription
replicator_arnstringAmazon Resource Name for the created replicator.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replicators resource, the following permissions are required: + +### Create +
+ec2:CreateNetworkInterface,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+iam:CreateServiceLinkedRole,
+iam:PassRole,
+kafka:CreateReplicator,
+kafka:CreateReplicatorReference,
+kafka:DescribeClusterV2,
+kafka:DescribeReplicator,
+kafka:GetBootstrapBrokers,
+kafka:ListTagsForResource,
+kafka:TagResource
+ +### List +
+kafka:ListReplicators
+ + +## Example +```sql +SELECT +region, +replicator_arn +FROM awscc.msk.replicators +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md b/docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md new file mode 100644 index 0000000000..302171a4c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md @@ -0,0 +1,69 @@ +--- +title: serverless_cluster +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_cluster + - 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 +--- +Gets an individual serverless_cluster resource + +## Overview + + + + + +
Nameserverless_cluster
TypeResource
Descriptionserverless_cluster
Idawscc.msk.serverless_cluster
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
cluster_namestring
vpc_configsarray
client_authenticationobject
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the serverless_cluster resource, the following permissions are required: + +### Read +
+kafka:DescribeClusterV2
+ +### Delete +
+kafka:DeleteCluster,
+kafka:DescribeClusterV2,
+ec2:DeleteVpcEndpoints
+ + +## Example +```sql +SELECT +region, +arn, +cluster_name, +vpc_configs, +client_authentication, +tags +FROM awscc.msk.serverless_cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md b/docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md new file mode 100644 index 0000000000..268f0d56e5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md @@ -0,0 +1,67 @@ +--- +title: serverless_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_clusters + - 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 +--- +Retrieves a list of serverless_clusters in a region + +## Overview + + + + + +
Nameserverless_clusters
TypeResource
Descriptionserverless_clusters
Idawscc.msk.serverless_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the serverless_clusters resource, the following permissions are required: + +### Create +
+kafka:CreateClusterV2,
+kafka:TagResource,
+kafka:DescribeClusterV2,
+ec2:CreateVpcEndpoint,
+ec2:CreateTags,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSubnets,
+ec2:DescribeVpcEndpoints,
+ec2:DescribeVpcs,
+ec2:DescribeSecurityGroups
+ +### List +
+kafka:ListClustersV2
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.msk.serverless_clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md b/docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md new file mode 100644 index 0000000000..d8d561bd21 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md @@ -0,0 +1,88 @@ +--- +title: vpc_connection +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connection + - 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 +--- +Gets an individual vpc_connection resource + +## Overview + + + + + +
Namevpc_connection
TypeResource
Descriptionvpc_connection
Idawscc.msk.vpc_connection
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
authenticationstring
client_subnetsarray
target_cluster_arnstringThe Amazon Resource Name (ARN) of the target cluster
security_groupsarray
tagsobject
vpc_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_connection resource, the following permissions are required: + +### Read +
+kafka:DescribeVpcConnection,
+kms:CreateGrant,
+kms:DescribeKey
+ +### Update +
+kafka:DescribeVpcConnection,
+kms:CreateGrant,
+kms:DescribeKey,
+kafka:TagResource,
+kafka:UntagResource
+ +### Delete +
+ec2:DeleteVpcEndpoint,
+ec2:DeleteVpcEndpoints,
+ec2:DescribeVpcEndpoints,
+ec2:DescribeVpcEndpointConnections,
+kafka:DeleteVpcConnection,
+kafka:DescribeVpcConnection,
+kms:CreateGrant,
+kms:DescribeKey
+ + +## Example +```sql +SELECT +region, +arn, +authentication, +client_subnets, +target_cluster_arn, +security_groups, +tags, +vpc_id +FROM awscc.msk.vpc_connection +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md b/docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md new file mode 100644 index 0000000000..6f44296f05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md @@ -0,0 +1,77 @@ +--- +title: vpc_connections +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connections + - 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 +--- +Retrieves a list of vpc_connections in a region + +## Overview + + + + + +
Namevpc_connections
TypeResource
Descriptionvpc_connections
Idawscc.msk.vpc_connections
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_connections resource, the following permissions are required: + +### Create +
+ec2:CreateVpcEndpoint,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+ec2:DescribeVpcEndpoints,
+ec2:AcceptVpcEndpointConnections,
+ec2:RejectVpcEndpointConnections,
+ec2:DescribeVpcEndpointConnections,
+ec2:CreateTags,
+iam:AttachRolePolicy,
+iam:CreateServiceLinkedRole,
+iam:PutRolePolicy,
+kafka:CreateVpcConnection,
+kafka:DescribeVpcConnection,
+kafka:TagResource,
+kms:CreateGrant,
+kms:DescribeKey
+ +### List +
+kafka:ListVpcConnections,
+kms:CreateGrant,
+kms:DescribeKey
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.msk.vpc_connections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mwaa/environment/index.md b/docs/awscc-docs/providers/awscc/mwaa/environment/index.md new file mode 100644 index 0000000000..71f0108f8c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mwaa/environment/index.md @@ -0,0 +1,119 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.mwaa.environment
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestring
arnstring
webserver_urlstring
execution_role_arnstring
kms_keystring
airflow_versionstring
source_bucket_arnstring
dag_s3_pathstring
plugins_s3_pathstring
plugins_s3_object_versionstring
requirements_s3_pathstring
requirements_s3_object_versionstring
startup_script_s3_pathstring
startup_script_s3_object_versionstring
airflow_configuration_optionsobjectKey/value pairs representing Airflow configuration variables.<br/> Keys are prefixed by their section:<br/><br/> [core]<br/> dags_folder={AIRFLOW_HOME}/dags<br/><br/> Would be represented as<br/><br/> "core.dags_folder": "{AIRFLOW_HOME}/dags"
environment_classstring
max_workersinteger
min_workersinteger
schedulersinteger
network_configurationobject
logging_configurationobject
weekly_maintenance_window_startstring
tagsobjectA map of tags for the environment.
webserver_access_modestring
endpoint_managementstring
celery_executor_queuestring
database_vpc_endpoint_servicestring
webserver_vpc_endpoint_servicestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+airflow:GetEnvironment
+ +### Update +
+airflow:UpdateEnvironment,
+airflow:TagResource,
+airflow:UntagResource
+ +### Delete +
+airflow:DeleteEnvironment
+ + +## Example +```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, +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 awscc.mwaa.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/mwaa/environments/index.md b/docs/awscc-docs/providers/awscc/mwaa/environments/index.md new file mode 100644 index 0000000000..15691426b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mwaa/environments/index.md @@ -0,0 +1,58 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.mwaa.environments
+ +## Fields + + + + + +
NameDatatypeDescription
nameundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+airflow:CreateEnvironment
+ +### List +
+airflow:ListEnvironments
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.mwaa.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/mwaa/index.md b/docs/awscc-docs/providers/awscc/mwaa/index.md new file mode 100644 index 0000000000..710143a5dd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/mwaa/index.md @@ -0,0 +1,39 @@ +--- +title: mwaa +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The mwaa service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+environment +
+
+environments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/neptune/db_cluster/index.md b/docs/awscc-docs/providers/awscc/neptune/db_cluster/index.md new file mode 100644 index 0000000000..b8862e0db9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptune/db_cluster/index.md @@ -0,0 +1,142 @@ +--- +title: db_cluster +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster + - 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 +--- +Gets an individual db_cluster resource + +## Overview + + + + + +
Namedb_cluster
TypeResource
Descriptiondb_cluster
Idawscc.neptune.db_cluster
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
endpointstringThe connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
read_endpointstringThe reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
cluster_resource_idstringThe 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.
associated_rolesarrayProvides 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.
availability_zonesarrayProvides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
backup_retention_periodintegerSpecifies the number of days for which automatic DB snapshots are retained.
copy_tags_to_snapshotbooleanA 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.
d_bcluster_identifierstringThe 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.
d_bcluster_parameter_group_namestringProvides the name of the DB cluster parameter group.
d_binstance_parameter_group_namestringThe 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.
d_bportintegerThe port number on which the DB instances in the DB cluster accept connections. <br/><br/>If not specified, the default port used is `8182`. <br/><br/>Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.
d_bsubnet_group_namestringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
deletion_protectionbooleanIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
enable_cloudwatch_logs_exportsarraySpecifies a list of log types that are enabled for export to CloudWatch Logs.
engine_versionstringIndicates the database engine version.
iam_auth_enabledbooleanTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
kms_key_idstringIf `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
portstringThe port number on which the DB cluster accepts connections. For example: `8182`.
preferred_backup_windowstringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
preferred_maintenance_windowstringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
restore_to_timestringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>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.<br/><br/>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.
restore_typestringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>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.<br/><br/>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.
serverless_scaling_configurationobjectContains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
snapshot_identifierstringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.<br/><br/>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.<br/><br/>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.
source_db_cluster_identifierstringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>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.<br/><br/>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.
storage_encryptedbooleanIndicates whether the DB cluster is encrypted.<br/><br/>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.<br/><br/>If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
tagsarrayThe tags assigned to this cluster.
use_latest_restorable_timebooleanCreates a new DB cluster from a DB snapshot or DB cluster snapshot.<br/><br/>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.<br/><br/>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.
vpc_security_group_idsarrayProvides a list of VPC security groups that the DB cluster belongs to.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_cluster resource, the following permissions are required: + +### Read +
+rds:DescribeDBClusters,
+rds:ListTagsForResource,
+kms:*
+ +### Update +
+ec2:DescribeSecurityGroups,
+iam:PassRole,
+rds:AddRoleToDBCluster,
+rds:AddTagsToResource,
+rds:DescribeDBClusters,
+rds:DescribeDBInstances,
+rds:DescribeDBSubnetGroups,
+rds:DescribeGlobalClusters,
+rds:ListTagsForResource,
+rds:ModifyDBCluster,
+rds:ModifyDBInstance,
+rds:RemoveFromGlobalCluster,
+rds:RemoveRoleFromDBCluster,
+rds:RemoveTagsFromResource,
+kms:*
+ +### Delete +
+rds:DeleteDBCluster,
+rds:DeleteDBInstance,
+rds:DescribeDBClusters,
+rds:DescribeGlobalClusters,
+rds:ListTagsForResource,
+rds:RemoveFromGlobalCluster,
+rds:CreateDBClusterSnapshot,
+kms:*
+ + +## Example +```sql +SELECT +region, +endpoint, +read_endpoint, +cluster_resource_id, +associated_roles, +availability_zones, +backup_retention_period, +copy_tags_to_snapshot, +d_bcluster_identifier, +d_bcluster_parameter_group_name, +d_binstance_parameter_group_name, +d_bport, +d_bsubnet_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 awscc.neptune.db_cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<DBClusterIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md b/docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md new file mode 100644 index 0000000000..5b209ca31a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md @@ -0,0 +1,70 @@ +--- +title: db_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - db_clusters + - 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 +--- +Retrieves a list of db_clusters in a region + +## Overview + + + + + +
Namedb_clusters
TypeResource
Descriptiondb_clusters
Idawscc.neptune.db_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
d_bcluster_identifierstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_clusters resource, the following permissions are required: + +### Create +
+iam:PassRole,
+rds:AddRoleToDBCluster,
+rds:AddTagsToResource,
+rds:CreateDBCluster,
+rds:CreateDBInstance,
+rds:DescribeDBClusters,
+rds:ListTagsForResource,
+rds:ModifyDBCluster,
+rds:RestoreDBClusterFromSnapshot,
+rds:RestoreDBClusterToPointInTime,
+kms:*
+ +### List +
+rds:DescribeDBClusters,
+rds:ListTagsForResource,
+kms:*
+ + +## Example +```sql +SELECT +region, +d_bcluster_identifier +FROM awscc.neptune.db_clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/neptune/index.md b/docs/awscc-docs/providers/awscc/neptune/index.md new file mode 100644 index 0000000000..e199f8d5ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptune/index.md @@ -0,0 +1,39 @@ +--- +title: neptune +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The neptune service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+db_cluster +
+
+db_clusters +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/neptunegraph/graph/index.md b/docs/awscc-docs/providers/awscc/neptunegraph/graph/index.md new file mode 100644 index 0000000000..b4089801e4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptunegraph/graph/index.md @@ -0,0 +1,97 @@ +--- +title: graph +hide_title: false +hide_table_of_contents: false +keywords: + - graph + - 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 +--- +Gets an individual graph resource + +## Overview + + + + + +
Namegraph
TypeResource
Descriptiongraph
Idawscc.neptunegraph.graph
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
deletion_protectionbooleanValue that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.<br/><br/>_Default_: If not specified, the default value is true.
graph_namestringContains a user-supplied name for the Graph. <br/><br/>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.<br/><br/>_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.
provisioned_memoryintegerMemory for the Graph.
public_connectivitybooleanSpecifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.<br/><br/>When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.<br/><br/>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.<br/><br/>_Default_: If not specified, the default value is false.
replica_countintegerSpecifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.<br/><br/>Replica Count should always be less than or equal to 2.<br/><br/>_Default_: If not specified, the default value is 1.
tagsarrayThe tags associated with this graph.
vector_search_configurationobjectVector Search Configuration
endpointstringThe connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`
graph_arnstringGraph resource ARN
graph_idstringThe auto-generated id assigned by the service.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the graph resource, the following permissions are required: + +### Read +
+neptune-graph:GetGraph,
+neptune-graph:ListTagsForResource,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:Decrypt
+ +### Update +
+iam:PassRole,
+neptune-graph:GetGraph,
+neptune-graph:ListTagsForResource,
+neptune-graph:TagResource,
+neptune-graph:UntagResource,
+neptune-graph:UpdateGraph,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:Decrypt
+ +### Delete +
+neptune-graph:DeleteGraph,
+neptune-graph:GetGraph,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +deletion_protection, +graph_name, +provisioned_memory, +public_connectivity, +replica_count, +tags, +vector_search_configuration, +endpoint, +graph_arn, +graph_id +FROM awscc.neptunegraph.graph +WHERE region = 'us-east-1' +AND data__Identifier = '<GraphId>' +``` diff --git a/docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md b/docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md new file mode 100644 index 0000000000..b4751eb593 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md @@ -0,0 +1,70 @@ +--- +title: graphs +hide_title: false +hide_table_of_contents: false +keywords: + - graphs + - 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 +--- +Retrieves a list of graphs in a region + +## Overview + + + + + +
Namegraphs
TypeResource
Descriptiongraphs
Idawscc.neptunegraph.graphs
+ +## Fields + + + + + +
NameDatatypeDescription
graph_idstringThe auto-generated id assigned by the service.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the graphs resource, the following permissions are required: + +### Create +
+iam:PassRole,
+neptune-graph:CreateGraph,
+neptune-graph:GetGraph,
+neptune-graph:ListTagsForResource,
+neptune-graph:TagResource,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:Decrypt,
+iam:CreateServiceLinkedRole
+ +### List +
+neptune-graph:GetGraph,
+neptune-graph:ListGraphs,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +graph_id +FROM awscc.neptunegraph.graphs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/neptunegraph/index.md b/docs/awscc-docs/providers/awscc/neptunegraph/index.md new file mode 100644 index 0000000000..9ed44e773d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptunegraph/index.md @@ -0,0 +1,41 @@ +--- +title: neptunegraph +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The neptunegraph service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+graph
+graphs +
+
+private_graph_endpoint
+private_graph_endpoints +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoint/index.md b/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoint/index.md new file mode 100644 index 0000000000..9ecd72c876 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoint/index.md @@ -0,0 +1,84 @@ +--- +title: private_graph_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - private_graph_endpoint + - 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 +--- +Gets an individual private_graph_endpoint resource + +## Overview + + + + + +
Nameprivate_graph_endpoint
TypeResource
Descriptionprivate_graph_endpoint
Idawscc.neptunegraph.private_graph_endpoint
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
graph_identifierstringThe auto-generated Graph Id assigned by the service.
security_group_idsarrayThe 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.
subnet_idsarrayThe 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.
vpc_idstringThe VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
private_graph_endpoint_identifierstringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.<br/><br/> For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
vpc_endpoint_idstringVPC endpoint that provides a private connection between the Graph and specified VPC.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the private_graph_endpoint resource, the following permissions are required: + +### Read +
+neptune-graph:GetPrivateGraphEndpoint
+ +### Update +
+iam:PassRole,
+neptune-graph:GetPrivateGraphEndpoint
+ +### Delete +
+ec2:DeleteVpcEndpoints,
+ec2:DescribeVpcEndpoints,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+ec2:DescribeVpcAttribute,
+ec2:DescribeAvailabilityZones,
+ec2:ModifyVpcEndpoint,
+route53:DisassociateVPCFromHostedZone,
+neptune-graph:DeletePrivateGraphEndpoint,
+neptune-graph:GetPrivateGraphEndpoint
+ + +## Example +```sql +SELECT +region, +graph_identifier, +security_group_ids, +subnet_ids, +vpc_id, +private_graph_endpoint_identifier, +vpc_endpoint_id +FROM awscc.neptunegraph.private_graph_endpoint +WHERE region = 'us-east-1' +AND data__Identifier = '<PrivateGraphEndpointIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoints/index.md b/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoints/index.md new file mode 100644 index 0000000000..1ce974bbf4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoints/index.md @@ -0,0 +1,71 @@ +--- +title: private_graph_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - private_graph_endpoints + - 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 +--- +Retrieves a list of private_graph_endpoints in a region + +## Overview + + + + + +
Nameprivate_graph_endpoints
TypeResource
Descriptionprivate_graph_endpoints
Idawscc.neptunegraph.private_graph_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
private_graph_endpoint_identifierstringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.<br/><br/> For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the private_graph_endpoints resource, the following permissions are required: + +### Create +
+ec2:CreateVpcEndpoint,
+ec2:DescribeVpcEndpoints,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+ec2:DescribeVpcAttribute,
+ec2:DescribeAvailabilityZones,
+ec2:ModifyVpcEndpoint,
+route53:AssociateVPCWithHostedZone,
+iam:PassRole,
+neptune-graph:CreatePrivateGraphEndpoint,
+neptune-graph:GetPrivateGraphEndpoint,
+iam:CreateServiceLinkedRole
+ +### List +
+neptune-graph:GetPrivateGraphEndpoint,
+neptune-graph:ListPrivateGraphEndpoints
+ + +## Example +```sql +SELECT +region, +private_graph_endpoint_identifier +FROM awscc.neptunegraph.private_graph_endpoints +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md new file mode 100644 index 0000000000..96727e17df --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md @@ -0,0 +1,103 @@ +--- +title: firewall +hide_title: false +hide_table_of_contents: false +keywords: + - firewall + - 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 +--- +Gets an individual firewall resource + +## Overview + + + + + +
Namefirewall
TypeResource
Descriptionfirewall
Idawscc.networkfirewall.firewall
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
firewall_namestring
firewall_arnstring
firewall_idstring
firewall_policy_arnstring
vpc_idstring
subnet_mappingsarray
delete_protectionboolean
subnet_change_protectionboolean
firewall_policy_change_protectionboolean
descriptionstring
endpoint_idsarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall resource, the following permissions are required: + +### Read +
+network-firewall:DescribeFirewall,
+network-firewall:ListTagsForResources
+ +### Update +
+network-firewall:AssociateSubnets,
+network-firewall:DisassociateSubnets,
+network-firewall:UpdateFirewallDescription,
+network-firewall:UpdateFirewallDeleteProtection,
+network-firewall:UpdateSubnetChangeProtection,
+network-firewall:UpdateFirewallPolicyChangeProtection,
+network-firewall:AssociateFirewallPolicy,
+network-firewall:TagResource,
+network-firewall:UntagResource,
+network-firewall:DescribeFirewall
+ +### Delete +
+ec2:DeleteVpcEndpoints,
+ec2:DescribeRouteTables,
+logs:DescribeLogGroups,
+logs:DescribeResourcePolicies,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+network-firewall:DeleteFirewall,
+network-firewall:UntagResource,
+network-firewall:DescribeFirewall
+ + +## Example +```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, +tags +FROM awscc.networkfirewall.firewall +WHERE region = 'us-east-1' +AND data__Identifier = '<FirewallArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md new file mode 100644 index 0000000000..ebac21ae13 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md @@ -0,0 +1,62 @@ +--- +title: firewall_policies +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_policies + - 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 +--- +Retrieves a list of firewall_policies in a region + +## Overview + + + + + +
Namefirewall_policies
TypeResource
Descriptionfirewall_policies
Idawscc.networkfirewall.firewall_policies
+ +## Fields + + + + + +
NameDatatypeDescription
firewall_policy_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_policies resource, the following permissions are required: + +### Create +
+network-firewall:CreateFirewallPolicy,
+network-firewall:DescribeFirewallPolicy,
+network-firewall:ListTLSInspectionConfigurations,
+network-firewall:TagResource,
+network-firewall:ListRuleGroups
+ +### List +
+network-firewall:ListFirewallPolicies
+ + +## Example +```sql +SELECT +region, +firewall_policy_arn +FROM awscc.networkfirewall.firewall_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md new file mode 100644 index 0000000000..f9aa357f5f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md @@ -0,0 +1,81 @@ +--- +title: firewall_policy +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_policy + - 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 +--- +Gets an individual firewall_policy resource + +## Overview + + + + + +
Namefirewall_policy
TypeResource
Descriptionfirewall_policy
Idawscc.networkfirewall.firewall_policy
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
firewall_policy_namestring
firewall_policy_arnstring
firewall_policyobject
firewall_policy_idstring
descriptionstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_policy resource, the following permissions are required: + +### Read +
+network-firewall:DescribeFirewallPolicy,
+network-firewall:ListTagsForResources
+ +### Update +
+network-firewall:UpdateFirewallPolicy,
+network-firewall:DescribeFirewallPolicy,
+network-firewall:TagResource,
+network-firewall:UntagResource,
+network-firewall:ListRuleGroups,
+network-firewall:ListTLSInspectionConfigurations
+ +### Delete +
+network-firewall:DeleteFirewallPolicy,
+network-firewall:DescribeFirewallPolicy,
+network-firewall:UntagResource
+ + +## Example +```sql +SELECT +region, +firewall_policy_name, +firewall_policy_arn, +firewall_policy, +firewall_policy_id, +description, +tags +FROM awscc.networkfirewall.firewall_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<FirewallPolicyArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md new file mode 100644 index 0000000000..9f53c3d006 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md @@ -0,0 +1,69 @@ +--- +title: firewalls +hide_title: false +hide_table_of_contents: false +keywords: + - firewalls + - 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 +--- +Retrieves a list of firewalls in a region + +## Overview + + + + + +
Namefirewalls
TypeResource
Descriptionfirewalls
Idawscc.networkfirewall.firewalls
+ +## Fields + + + + + +
NameDatatypeDescription
firewall_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewalls resource, the following permissions are required: + +### Create +
+ec2:CreateVpcEndpoint,
+ec2:DescribeVpcEndpoints,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs,
+iam:CreateServiceLinkedRole,
+network-firewall:CreateFirewall,
+network-firewall:DescribeFirewallPolicy,
+network-firewall:DescribeRuleGroup,
+network-firewall:TagResource,
+network-firewall:AssociateSubnets,
+network-firewall:AssociateFirewallPolicy,
+network-firewall:DescribeFirewall
+ +### List +
+network-firewall:ListFirewalls
+ + +## Example +```sql +SELECT +region, +firewall_arn +FROM awscc.networkfirewall.firewalls +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/index.md new file mode 100644 index 0000000000..3422f4e2cc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/index.md @@ -0,0 +1,47 @@ +--- +title: networkfirewall +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The networkfirewall service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+firewall
+firewall_policies
+firewall_policy
+firewalls
+logging_configuration +
+
+logging_configurations
+rule_group
+rule_groups
+tls_inspection_configuration
+tls_inspection_configurations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/logging_configuration/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/logging_configuration/index.md new file mode 100644 index 0000000000..aaf9365d07 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/logging_configuration/index.md @@ -0,0 +1,86 @@ +--- +title: logging_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configuration + - 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 +--- +Gets an individual logging_configuration resource + +## Overview + + + + + +
Namelogging_configuration
TypeResource
Descriptionlogging_configuration
Idawscc.networkfirewall.logging_configuration
+ +## Fields + + + + + + + +
NameDatatypeDescription
firewall_namestring
firewall_arnstring
logging_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the logging_configuration resource, the following permissions are required: + +### Read +
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+network-firewall:DescribeLoggingConfiguration
+ +### Update +
+logs:CreateLogDelivery,
+logs:DeleteLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:ListLogDeliveries,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+iam:CreateServiceLinkedRole,
+firehose:TagDeliveryStream,
+network-firewall:UpdateLoggingConfiguration,
+network-firewall:DescribeLoggingConfiguration
+ +### Delete +
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:GetLogDelivery,
+network-firewall:UpdateLoggingConfiguration,
+network-firewall:DescribeLoggingConfiguration
+ + +## Example +```sql +SELECT +region, +firewall_name, +firewall_arn, +logging_configuration +FROM awscc.networkfirewall.logging_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<FirewallArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md new file mode 100644 index 0000000000..a6626c226b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md @@ -0,0 +1,71 @@ +--- +title: logging_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations + - 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 +--- +Retrieves a list of logging_configurations in a region + +## Overview + + + + + +
Namelogging_configurations
TypeResource
Descriptionlogging_configurations
Idawscc.networkfirewall.logging_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
firewall_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the logging_configurations resource, the following permissions are required: + +### Create +
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+iam:CreateServiceLinkedRole,
+firehose:TagDeliveryStream,
+network-firewall:UpdateLoggingConfiguration,
+network-firewall:DescribeLoggingConfiguration
+ +### List +
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+network-firewall:DescribeLoggingConfiguration
+ + +## Example +```sql +SELECT +region, +firewall_arn +FROM awscc.networkfirewall.logging_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md new file mode 100644 index 0000000000..132d5df96e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md @@ -0,0 +1,85 @@ +--- +title: rule_group +hide_title: false +hide_table_of_contents: false +keywords: + - rule_group + - 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 +--- +Gets an individual rule_group resource + +## Overview + + + + + +
Namerule_group
TypeResource
Descriptionrule_group
Idawscc.networkfirewall.rule_group
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
rule_group_namestring
rule_group_arnstring
rule_group_idstring
rule_groupobject
typestring
capacityinteger
descriptionstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule_group resource, the following permissions are required: + +### Read +
+network-firewall:DescribeRuleGroup,
+network-firewall:ListTagsForResources
+ +### Update +
+network-firewall:UpdateRuleGroup,
+network-firewall:DescribeRuleGroup,
+network-firewall:TagResource,
+network-firewall:UntagResource,
+iam:CreateServiceLinkedRole,
+ec2:GetManagedPrefixListEntries
+ +### Delete +
+network-firewall:DeleteRuleGroup,
+network-firewall:DescribeRuleGroup,
+network-firewall:UntagResource
+ + +## Example +```sql +SELECT +region, +rule_group_name, +rule_group_arn, +rule_group_id, +rule_group, +type, +capacity, +description, +tags +FROM awscc.networkfirewall.rule_group +WHERE region = 'us-east-1' +AND data__Identifier = '<RuleGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md new file mode 100644 index 0000000000..478fbcbb8c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md @@ -0,0 +1,63 @@ +--- +title: rule_groups +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups + - 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 +--- +Retrieves a list of rule_groups in a region + +## Overview + + + + + +
Namerule_groups
TypeResource
Descriptionrule_groups
Idawscc.networkfirewall.rule_groups
+ +## Fields + + + + + +
NameDatatypeDescription
rule_group_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule_groups resource, the following permissions are required: + +### Create +
+network-firewall:CreateRuleGroup,
+network-firewall:DescribeRuleGroup,
+network-firewall:TagResource,
+network-firewall:ListRuleGroups,
+iam:CreateServiceLinkedRole,
+ec2:GetManagedPrefixListEntries
+ +### List +
+network-firewall:ListRuleGroups
+ + +## Example +```sql +SELECT +region, +rule_group_arn +FROM awscc.networkfirewall.rule_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configuration/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configuration/index.md new file mode 100644 index 0000000000..50c89d7d8b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configuration/index.md @@ -0,0 +1,79 @@ +--- +title: tls_inspection_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - tls_inspection_configuration + - 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 +--- +Gets an individual tls_inspection_configuration resource + +## Overview + + + + + +
Nametls_inspection_configuration
TypeResource
Descriptiontls_inspection_configuration
Idawscc.networkfirewall.tls_inspection_configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
t_ls_inspection_configuration_namestring
t_ls_inspection_configuration_arnstring
t_ls_inspection_configurationobject
t_ls_inspection_configuration_idstring
descriptionstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tls_inspection_configuration resource, the following permissions are required: + +### Read +
+network-firewall:DescribeTLSInspectionConfiguration,
+network-firewall:ListTagsForResources
+ +### Update +
+network-firewall:UpdateTLSInspectionConfiguration,
+network-firewall:DescribeTLSInspectionConfiguration,
+network-firewall:TagResource,
+network-firewall:UntagResource
+ +### Delete +
+network-firewall:DeleteTLSInspectionConfiguration,
+network-firewall:DescribeTLSInspectionConfiguration,
+network-firewall:UntagResource
+ + +## Example +```sql +SELECT +region, +t_ls_inspection_configuration_name, +t_ls_inspection_configuration_arn, +t_ls_inspection_configuration, +t_ls_inspection_configuration_id, +description, +tags +FROM awscc.networkfirewall.tls_inspection_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<TLSInspectionConfigurationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configurations/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configurations/index.md new file mode 100644 index 0000000000..66676c326c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: tls_inspection_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - tls_inspection_configurations + - 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 +--- +Retrieves a list of tls_inspection_configurations in a region + +## Overview + + + + + +
Nametls_inspection_configurations
TypeResource
Descriptiontls_inspection_configurations
Idawscc.networkfirewall.tls_inspection_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
t_ls_inspection_configuration_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tls_inspection_configurations resource, the following permissions are required: + +### Create +
+network-firewall:CreateTLSInspectionConfiguration,
+network-firewall:DescribeTLSInspectionConfiguration,
+network-firewall:TagResource
+ +### List +
+network-firewall:ListTLSInspectionConfigurations
+ + +## Example +```sql +SELECT +region, +t_ls_inspection_configuration_arn +FROM awscc.networkfirewall.tls_inspection_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md new file mode 100644 index 0000000000..ec3bbc0c20 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md @@ -0,0 +1,99 @@ +--- +title: connect_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - connect_attachment + - 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 +--- +Gets an individual connect_attachment resource + +## Overview + + + + + +
Nameconnect_attachment
TypeResource
Descriptionconnect_attachment
Idawscc.networkmanager.connect_attachment
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringID of the CoreNetwork that the attachment will be attached to.
core_network_arnstringThe ARN of a core network.
attachment_idstringThe ID of the attachment.
owner_account_idstringThe ID of the attachment account owner.
attachment_typestringThe type of attachment.
statestringState of the attachment.
edge_locationstringEdge location of the attachment.
resource_arnstringThe attachment resource ARN.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment attachment.
proposed_segment_changeobjectThe attachment to move from one segment to another.
tagsarrayTags for the attachment.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
transport_attachment_idstringId of transport attachment
optionsobjectProtocol options for connect attachment
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connect_attachment resource, the following permissions are required: + +### Read +
+networkmanager:GetConnectAttachment
+ +### Update +
+networkmanager:GetConnectAttachment,
+networkmanager:ListTagsForResource,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+ec2:DescribeRegions
+ +### Delete +
+networkmanager:GetConnectAttachment,
+networkmanager:DeleteAttachment,
+ec2:DescribeRegions
+ + +## Example +```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, +tags, +created_at, +updated_at, +transport_attachment_id, +options +FROM awscc.networkmanager.connect_attachment +WHERE region = 'us-east-1' +AND data__Identifier = '<AttachmentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md new file mode 100644 index 0000000000..5ebb6fce48 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md @@ -0,0 +1,61 @@ +--- +title: connect_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - connect_attachments + - 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 +--- +Retrieves a list of connect_attachments in a region + +## Overview + + + + + +
Nameconnect_attachments
TypeResource
Descriptionconnect_attachments
Idawscc.networkmanager.connect_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connect_attachments resource, the following permissions are required: + +### Create +
+networkmanager:GetConnectAttachment,
+networkmanager:CreateConnectAttachment,
+networkmanager:TagResource,
+ec2:DescribeRegions
+ +### List +
+networkmanager:ListAttachments
+ + +## Example +```sql +SELECT +region, +attachment_id +FROM awscc.networkmanager.connect_attachments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md new file mode 100644 index 0000000000..8a0dd447b1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md @@ -0,0 +1,93 @@ +--- +title: connect_peer +hide_title: false +hide_table_of_contents: false +keywords: + - connect_peer + - 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 +--- +Gets an individual connect_peer resource + +## Overview + + + + + +
Nameconnect_peer
TypeResource
Descriptionconnect_peer
Idawscc.networkmanager.connect_peer
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
peer_addressstringThe IP address of the Connect peer.
core_network_addressstringThe IP address of a core network.
bgp_optionsobjectBgp options for connect peer.
inside_cidr_blocksarrayThe inside IP addresses used for a Connect peer configuration.
core_network_idstringThe ID of the core network.
connect_attachment_idstringThe ID of the attachment to connect.
connect_peer_idstringThe ID of the Connect peer.
edge_locationstringThe Connect peer Regions where edges are located.
statestringState of the connect peer.
created_atstringConnect peer creation time.
configurationobjectConfiguration of the connect peer.
subnet_arnstringThe subnet ARN for the connect peer.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connect_peer resource, the following permissions are required: + +### Read +
+networkmanager:GetConnectPeer
+ +### Update +
+networkmanager:GetConnectPeer,
+networkmanager:ListTagsForResource,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+ec2:DescribeRegions
+ +### Delete +
+networkmanager:GetConnectPeer,
+networkmanager:DeleteConnectPeer,
+ec2:DescribeRegions
+ + +## Example +```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, +tags +FROM awscc.networkmanager.connect_peer +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectPeerId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md new file mode 100644 index 0000000000..121186fefc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md @@ -0,0 +1,61 @@ +--- +title: connect_peers +hide_title: false +hide_table_of_contents: false +keywords: + - connect_peers + - 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 +--- +Retrieves a list of connect_peers in a region + +## Overview + + + + + +
Nameconnect_peers
TypeResource
Descriptionconnect_peers
Idawscc.networkmanager.connect_peers
+ +## Fields + + + + + +
NameDatatypeDescription
connect_peer_idstringThe ID of the Connect peer.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connect_peers resource, the following permissions are required: + +### Create +
+networkmanager:GetConnectPeer,
+networkmanager:CreateConnectPeer,
+networkmanager:TagResource,
+ec2:DescribeRegions
+ +### List +
+networkmanager:ListConnectPeers
+ + +## Example +```sql +SELECT +region, +connect_peer_id +FROM awscc.networkmanager.connect_peers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md b/docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md new file mode 100644 index 0000000000..1d81dceb90 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md @@ -0,0 +1,96 @@ +--- +title: core_network +hide_title: false +hide_table_of_contents: false +keywords: + - core_network + - 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 +--- +Gets an individual core_network resource + +## Overview + + + + + +
Namecore_network
TypeResource
Descriptioncore_network
Idawscc.networkmanager.core_network
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network that your core network is a part of.
core_network_idstringThe Id of core network
core_network_arnstringThe ARN (Amazon resource name) of core network
policy_documentobjectLive policy document for the core network, you must provide PolicyDocument in Json Format
descriptionstringThe description of core network
created_atstringThe creation time of core network
statestringThe state of core network
segmentsarrayThe segments within a core network.
edgesarrayThe edges within a core network.
owner_accountstringOwner of the core network
tagsarrayThe tags for the global network.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the core_network resource, the following permissions are required: + +### Read +
+networkmanager:GetCoreNetwork,
+networkmanager:GetCoreNetworkPolicy
+ +### Update +
+networkmanager:UpdateCoreNetwork,
+networkmanager:GetCoreNetwork,
+networkmanager:ListTagsForResource,
+networkmanager:PutCoreNetworkPolicy,
+networkmanager:GetCoreNetworkPolicy,
+networkmanager:ExecuteCoreNetworkChangeSet,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+ec2:DescribeRegions
+ +### Delete +
+networkmanager:DeleteCoreNetwork,
+networkmanager:UntagResource,
+networkmanager:GetCoreNetwork,
+networkmanager:GetCoreNetworkPolicy,
+ec2:DescribeRegions
+ + +## Example +```sql +SELECT +region, +global_network_id, +core_network_id, +core_network_arn, +policy_document, +description, +created_at, +state, +segments, +edges, +owner_account, +tags +FROM awscc.networkmanager.core_network +WHERE region = 'us-east-1' +AND data__Identifier = '<CoreNetworkId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md b/docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md new file mode 100644 index 0000000000..f4f674576c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md @@ -0,0 +1,62 @@ +--- +title: core_networks +hide_title: false +hide_table_of_contents: false +keywords: + - core_networks + - 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 +--- +Retrieves a list of core_networks in a region + +## Overview + + + + + +
Namecore_networks
TypeResource
Descriptioncore_networks
Idawscc.networkmanager.core_networks
+ +## Fields + + + + + +
NameDatatypeDescription
core_network_idstringThe Id of core network
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the core_networks resource, the following permissions are required: + +### Create +
+networkmanager:CreateCoreNetwork,
+networkmanager:GetCoreNetwork,
+networkmanager:GetCoreNetworkPolicy,
+networkmanager:TagResource,
+ec2:DescribeRegions
+ +### List +
+networkmanager:ListCoreNetworks
+ + +## Example +```sql +SELECT +region, +core_network_id +FROM awscc.networkmanager.core_networks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_association/index.md b/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_association/index.md new file mode 100644 index 0000000000..76bc5513b3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_association/index.md @@ -0,0 +1,66 @@ +--- +title: customer_gateway_association +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateway_association + - 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 +--- +Gets an individual customer_gateway_association resource + +## Overview + + + + + +
Namecustomer_gateway_association
TypeResource
Descriptioncustomer_gateway_association
Idawscc.networkmanager.customer_gateway_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
customer_gateway_arnstringThe Amazon Resource Name (ARN) of the customer gateway.
device_idstringThe ID of the device
link_idstringThe ID of the link
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the customer_gateway_association resource, the following permissions are required: + +### Read +
+networkmanager:GetCustomerGatewayAssociations
+ +### Delete +
+networkmanager:DisassociateCustomerGateway
+ + +## Example +```sql +SELECT +region, +global_network_id, +customer_gateway_arn, +device_id, +link_id +FROM awscc.networkmanager.customer_gateway_association +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalNetworkId>' +AND data__Identifier = '<CustomerGatewayArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_associations/index.md b/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_associations/index.md new file mode 100644 index 0000000000..1c6b08ac0d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_associations/index.md @@ -0,0 +1,61 @@ +--- +title: customer_gateway_associations +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateway_associations + - 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 +--- +Retrieves a list of customer_gateway_associations in a region + +## Overview + + + + + +
Namecustomer_gateway_associations
TypeResource
Descriptioncustomer_gateway_associations
Idawscc.networkmanager.customer_gateway_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
customer_gateway_arnstringThe Amazon Resource Name (ARN) of the customer gateway.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the customer_gateway_associations resource, the following permissions are required: + +### Create +
+networkmanager:GetCustomerGatewayAssociations,
+networkmanager:AssociateCustomerGateway
+ +### List +
+networkmanager:GetCustomerGatewayAssociations
+ + +## Example +```sql +SELECT +region, +global_network_id, +customer_gateway_arn +FROM awscc.networkmanager.customer_gateway_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/device/index.md b/docs/awscc-docs/providers/awscc/networkmanager/device/index.md new file mode 100644 index 0000000000..0b00fa00dd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/device/index.md @@ -0,0 +1,95 @@ +--- +title: device +hide_title: false +hide_table_of_contents: false +keywords: + - device + - 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 +--- +Gets an individual device resource + +## Overview + + + + + +
Namedevice
TypeResource
Descriptiondevice
Idawscc.networkmanager.device
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
device_arnstringThe Amazon Resource Name (ARN) of the device.
device_idstringThe ID of the device.
descriptionstringThe description of the device.
tagsarrayThe tags for the device.
global_network_idstringThe ID of the global network.
a_ws_locationobjectThe Amazon Web Services location of the device, if applicable.
locationobjectThe site location.
modelstringThe device model
serial_numberstringThe device serial number.
site_idstringThe site ID.
typestringThe device type.
vendorstringThe device vendor.
created_atstringThe date and time that the device was created.
statestringThe state of the device.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the device resource, the following permissions are required: + +### Read +
+networkmanager:GetDevices
+ +### Update +
+networkmanager:UpdateDevice,
+networkmanager:ListTagsForResource,
+networkmanager:GetDevices,
+networkmanager:TagResource,
+networkmanager:UntagResource
+ +### Delete +
+networkmanager:GetDevices,
+networkmanager:DeleteDevice
+ + +## Example +```sql +SELECT +region, +device_arn, +device_id, +description, +tags, +global_network_id, +a_ws_location, +location, +model, +serial_number, +site_id, +type, +vendor, +created_at, +state +FROM awscc.networkmanager.device +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalNetworkId>' +AND data__Identifier = '<DeviceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/devices/index.md b/docs/awscc-docs/providers/awscc/networkmanager/devices/index.md new file mode 100644 index 0000000000..98e887ac7d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/devices/index.md @@ -0,0 +1,62 @@ +--- +title: devices +hide_title: false +hide_table_of_contents: false +keywords: + - devices + - 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 +--- +Retrieves a list of devices in a region + +## Overview + + + + + +
Namedevices
TypeResource
Descriptiondevices
Idawscc.networkmanager.devices
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
device_idstringThe ID of the device.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the devices resource, the following permissions are required: + +### Create +
+networkmanager:CreateDevice,
+networkmanager:GetDevices,
+networkmanager:TagResource
+ +### List +
+networkmanager:GetDevices
+ + +## Example +```sql +SELECT +region, +global_network_id, +device_id +FROM awscc.networkmanager.devices +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md b/docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md new file mode 100644 index 0000000000..e971d8d4c8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md @@ -0,0 +1,78 @@ +--- +title: global_network +hide_title: false +hide_table_of_contents: false +keywords: + - global_network + - 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 +--- +Gets an individual global_network resource + +## Overview + + + + + +
Nameglobal_network
TypeResource
Descriptionglobal_network
Idawscc.networkmanager.global_network
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the global network.
idstringThe ID of the global network.
descriptionstringThe description of the global network.
tagsarrayThe tags for the global network.
created_atstringThe date and time that the global network was created.
statestringThe state of the global network.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_network resource, the following permissions are required: + +### Read +
+networkmanager:DescribeGlobalNetworks
+ +### Update +
+networkmanager:UpdateGlobalNetwork,
+networkmanager:DescribeGlobalNetworks,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+networkmanager:ListTagsForResource
+ +### Delete +
+networkmanager:DeleteGlobalNetwork,
+networkmanager:DescribeGlobalNetworks
+ + +## Example +```sql +SELECT +region, +arn, +id, +description, +tags, +created_at, +state +FROM awscc.networkmanager.global_network +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md b/docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md new file mode 100644 index 0000000000..a96f314408 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md @@ -0,0 +1,61 @@ +--- +title: global_networks +hide_title: false +hide_table_of_contents: false +keywords: + - global_networks + - 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 +--- +Retrieves a list of global_networks in a region + +## Overview + + + + + +
Nameglobal_networks
TypeResource
Descriptionglobal_networks
Idawscc.networkmanager.global_networks
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the global network.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_networks resource, the following permissions are required: + +### Create +
+networkmanager:CreateGlobalNetwork,
+networkmanager:DescribeGlobalNetworks,
+networkmanager:TagResource,
+iam:CreateServiceLinkedRole
+ +### List +
+networkmanager:DescribeGlobalNetworks
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.networkmanager.global_networks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/index.md b/docs/awscc-docs/providers/awscc/networkmanager/index.md new file mode 100644 index 0000000000..786dcfca9f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/index.md @@ -0,0 +1,65 @@ +--- +title: networkmanager +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The networkmanager service documentation. + +:::info Service Summary + +
+
+total resources: 28
+total selectable resources: 28
+total methods: 28
+
+
+ +::: + +## Resources +
+
+connect_attachment
+connect_attachments
+connect_peer
+connect_peers
+core_network
+core_networks
+customer_gateway_association
+customer_gateway_associations
+device
+devices
+global_network
+global_networks
+link
+link_association +
+
+link_associations
+links
+site
+site_to_site_vpn_attachment
+site_to_site_vpn_attachments
+sites
+transit_gateway_peering
+transit_gateway_peerings
+transit_gateway_registration
+transit_gateway_registrations
+transit_gateway_route_table_attachment
+transit_gateway_route_table_attachments
+vpc_attachment
+vpc_attachments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/networkmanager/link/index.md b/docs/awscc-docs/providers/awscc/networkmanager/link/index.md new file mode 100644 index 0000000000..4ba2635742 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/link/index.md @@ -0,0 +1,89 @@ +--- +title: link +hide_title: false +hide_table_of_contents: false +keywords: + - link + - 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 +--- +Gets an individual link resource + +## Overview + + + + + +
Namelink
TypeResource
Descriptionlink
Idawscc.networkmanager.link
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
link_arnstringThe Amazon Resource Name (ARN) of the link.
link_idstringThe ID of the link.
global_network_idstringThe ID of the global network.
site_idstringThe ID of the site
bandwidthobjectThe Bandwidth for the link.
providerstringThe provider of the link.
descriptionstringThe description of the link.
tagsarrayThe tags for the link.
typestringThe type of the link.
created_atstringThe date and time that the device was created.
statestringThe state of the link.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the link resource, the following permissions are required: + +### Read +
+networkmanager:GetLinks
+ +### Update +
+networkmanager:ListTagsForResource,
+networkmanager:TagResource,
+networkmanager:GetLinks,
+networkmanager:UntagResource,
+networkmanager:UpdateLink
+ +### Delete +
+networkmanager:GetLinks,
+networkmanager:DeleteLink
+ + +## Example +```sql +SELECT +region, +link_arn, +link_id, +global_network_id, +site_id, +bandwidth, +provider, +description, +tags, +type, +created_at, +state +FROM awscc.networkmanager.link +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalNetworkId>' +AND data__Identifier = '<LinkId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md b/docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md new file mode 100644 index 0000000000..1f18b42964 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md @@ -0,0 +1,65 @@ +--- +title: link_association +hide_title: false +hide_table_of_contents: false +keywords: + - link_association + - 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 +--- +Gets an individual link_association resource + +## Overview + + + + + +
Namelink_association
TypeResource
Descriptionlink_association
Idawscc.networkmanager.link_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
device_idstringThe ID of the device
link_idstringThe ID of the link
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the link_association resource, the following permissions are required: + +### Read +
+networkmanager:GetLinkAssociations
+ +### Delete +
+networkmanager:DisassociateLink
+ + +## Example +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM awscc.networkmanager.link_association +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalNetworkId>' +AND data__Identifier = '<DeviceId>' +AND data__Identifier = '<LinkId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md b/docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md new file mode 100644 index 0000000000..66d4738ee6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md @@ -0,0 +1,63 @@ +--- +title: link_associations +hide_title: false +hide_table_of_contents: false +keywords: + - link_associations + - 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 +--- +Retrieves a list of link_associations in a region + +## Overview + + + + + +
Namelink_associations
TypeResource
Descriptionlink_associations
Idawscc.networkmanager.link_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
device_idstringThe ID of the device
link_idstringThe ID of the link
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the link_associations resource, the following permissions are required: + +### Create +
+networkmanager:GetLinkAssociations,
+networkmanager:AssociateLink
+ +### List +
+networkmanager:GetLinkAssociations
+ + +## Example +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM awscc.networkmanager.link_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/links/index.md b/docs/awscc-docs/providers/awscc/networkmanager/links/index.md new file mode 100644 index 0000000000..3dcf843698 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/links/index.md @@ -0,0 +1,62 @@ +--- +title: links +hide_title: false +hide_table_of_contents: false +keywords: + - links + - 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 +--- +Retrieves a list of links in a region + +## Overview + + + + + +
Namelinks
TypeResource
Descriptionlinks
Idawscc.networkmanager.links
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
link_idstringThe ID of the link.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the links resource, the following permissions are required: + +### Create +
+networkmanager:CreateLink,
+networkmanager:GetLinks,
+networkmanager:TagResource
+ +### List +
+networkmanager:GetLinks
+ + +## Example +```sql +SELECT +region, +global_network_id, +link_id +FROM awscc.networkmanager.links +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/site/index.md b/docs/awscc-docs/providers/awscc/networkmanager/site/index.md new file mode 100644 index 0000000000..c79f92b2e9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/site/index.md @@ -0,0 +1,83 @@ +--- +title: site +hide_title: false +hide_table_of_contents: false +keywords: + - site + - 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 +--- +Gets an individual site resource + +## Overview + + + + + +
Namesite
TypeResource
Descriptionsite
Idawscc.networkmanager.site
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
site_arnstringThe Amazon Resource Name (ARN) of the site.
site_idstringThe ID of the site.
descriptionstringThe description of the site.
tagsarrayThe tags for the site.
global_network_idstringThe ID of the global network.
locationobjectThe location of the site.
created_atstringThe date and time that the device was created.
statestringThe state of the site.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the site resource, the following permissions are required: + +### Read +
+networkmanager:GetSites
+ +### Update +
+networkmanager:GetSites,
+networkmanager:ListTagsForResource,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+networkmanager:UpdateSite
+ +### Delete +
+networkmanager:GetSites,
+networkmanager:DeleteSite
+ + +## Example +```sql +SELECT +region, +site_arn, +site_id, +description, +tags, +global_network_id, +location, +created_at, +state +FROM awscc.networkmanager.site +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalNetworkId>' +AND data__Identifier = '<SiteId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachment/index.md b/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachment/index.md new file mode 100644 index 0000000000..714ea1ac41 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachment/index.md @@ -0,0 +1,97 @@ +--- +title: site_to_site_vpn_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - site_to_site_vpn_attachment + - 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 +--- +Gets an individual site_to_site_vpn_attachment resource + +## Overview + + + + + +
Namesite_to_site_vpn_attachment
TypeResource
Descriptionsite_to_site_vpn_attachment
Idawscc.networkmanager.site_to_site_vpn_attachment
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringThe ID of a core network where you're creating a site-to-site VPN attachment.
core_network_arnstringThe ARN of a core network for the VPC attachment.
attachment_idstringThe ID of the attachment.
owner_account_idstringOwner account of the attachment.
attachment_typestringThe type of attachment.
statestringThe state of the attachment.
edge_locationstringThe Region where the edge is located.
resource_arnstringThe ARN of the Resource.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment that attachment is in.
proposed_segment_changeobjectThe attachment to move from one segment to another.
tagsarrayTags for the attachment.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
vpn_connection_arnstringThe ARN of the site-to-site VPN attachment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the site_to_site_vpn_attachment resource, the following permissions are required: + +### Read +
+networkmanager:GetSiteToSiteVpnAttachment
+ +### Update +
+networkmanager:GetSiteToSiteVpnAttachment,
+networkmanager:ListTagsForResource,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+ec2:DescribeRegions
+ +### Delete +
+networkmanager:GetSiteToSiteVpnAttachment,
+networkmanager:DeleteAttachment,
+ec2:DescribeRegions
+ + +## Example +```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, +tags, +created_at, +updated_at, +vpn_connection_arn +FROM awscc.networkmanager.site_to_site_vpn_attachment +WHERE region = 'us-east-1' +AND data__Identifier = '<AttachmentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachments/index.md b/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachments/index.md new file mode 100644 index 0000000000..93e4a80a7e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachments/index.md @@ -0,0 +1,61 @@ +--- +title: site_to_site_vpn_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - site_to_site_vpn_attachments + - 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 +--- +Retrieves a list of site_to_site_vpn_attachments in a region + +## Overview + + + + + +
Namesite_to_site_vpn_attachments
TypeResource
Descriptionsite_to_site_vpn_attachments
Idawscc.networkmanager.site_to_site_vpn_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the site_to_site_vpn_attachments resource, the following permissions are required: + +### Create +
+networkmanager:GetSiteToSiteVpnAttachment,
+networkmanager:CreateSiteToSiteVpnAttachment,
+ec2:DescribeRegions,
+networkmanager:TagResource
+ +### List +
+networkmanager:ListAttachments
+ + +## Example +```sql +SELECT +region, +attachment_id +FROM awscc.networkmanager.site_to_site_vpn_attachments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/sites/index.md b/docs/awscc-docs/providers/awscc/networkmanager/sites/index.md new file mode 100644 index 0000000000..015d3d77c0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/sites/index.md @@ -0,0 +1,62 @@ +--- +title: sites +hide_title: false +hide_table_of_contents: false +keywords: + - sites + - 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 +--- +Retrieves a list of sites in a region + +## Overview + + + + + +
Namesites
TypeResource
Descriptionsites
Idawscc.networkmanager.sites
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
site_idstringThe ID of the site.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sites resource, the following permissions are required: + +### Create +
+networkmanager:CreateSite,
+networkmanager:GetSites,
+networkmanager:TagResource
+ +### List +
+networkmanager:GetSites
+ + +## Example +```sql +SELECT +region, +global_network_id, +site_id +FROM awscc.networkmanager.sites +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peering/index.md b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peering/index.md new file mode 100644 index 0000000000..d617cda99a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peering/index.md @@ -0,0 +1,92 @@ +--- +title: transit_gateway_peering +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering + - 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 +--- +Gets an individual transit_gateway_peering resource + +## Overview + + + + + +
Nametransit_gateway_peering
TypeResource
Descriptiontransit_gateway_peering
Idawscc.networkmanager.transit_gateway_peering
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringThe Id of the core network that you want to peer a transit gateway to.
core_network_arnstringThe ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.
transit_gateway_arnstringThe ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network
transit_gateway_peering_attachment_idstringThe ID of the TransitGatewayPeeringAttachment
peering_idstringThe Id of the transit gateway peering
statestringThe state of the transit gateway peering
edge_locationstringThe location of the transit gateway peering
resource_arnstringThe ARN (Amazon Resource Name) of the resource that you will peer to a core network
owner_account_idstringPeering owner account Id
peering_typestringPeering type (TransitGatewayPeering)
created_atstringThe creation time of the transit gateway peering
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transit_gateway_peering resource, the following permissions are required: + +### Read +
+networkmanager:GetTransitGatewayPeering,
+networkmanager:TagResource
+ +### Update +
+networkmanager:TagResource,
+networkmanager:UntagResource,
+networkmanager:ListTagsForResource,
+networkmanager:GetTransitGatewayPeering,
+ec2:DescribeRegions
+ +### Delete +
+networkmanager:DeletePeering,
+networkmanager:GetTransitGatewayPeering,
+ec2:DescribeRegions
+ + +## Example +```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, +tags +FROM awscc.networkmanager.transit_gateway_peering +WHERE region = 'us-east-1' +AND data__Identifier = '<PeeringId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peerings/index.md b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peerings/index.md new file mode 100644 index 0000000000..81b4f6637c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peerings/index.md @@ -0,0 +1,64 @@ +--- +title: transit_gateway_peerings +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peerings + - 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 +--- +Retrieves a list of transit_gateway_peerings in a region + +## Overview + + + + + +
Nametransit_gateway_peerings
TypeResource
Descriptiontransit_gateway_peerings
Idawscc.networkmanager.transit_gateway_peerings
+ +## Fields + + + + + +
NameDatatypeDescription
peering_idstringThe Id of the transit gateway peering
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transit_gateway_peerings resource, the following permissions are required: + +### Create +
+networkmanager:CreateTransitGatewayPeering,
+networkmanager:TagResource,
+networkmanager:GetTransitGatewayPeering,
+iam:CreateServiceLinkedRole,
+ec2:CreateTransitGatewayPeeringAttachment,
+ec2:AcceptTransitGatewayPeeringAttachment,
+ec2:DescribeRegions
+ +### List +
+networkmanager:ListPeerings
+ + +## Example +```sql +SELECT +region, +peering_id +FROM awscc.networkmanager.transit_gateway_peerings +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registration/index.md b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registration/index.md new file mode 100644 index 0000000000..df340b7ede --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registration/index.md @@ -0,0 +1,63 @@ +--- +title: transit_gateway_registration +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_registration + - 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 +--- +Gets an individual transit_gateway_registration resource + +## Overview + + + + + +
Nametransit_gateway_registration
TypeResource
Descriptiontransit_gateway_registration
Idawscc.networkmanager.transit_gateway_registration
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
transit_gateway_arnstringThe Amazon Resource Name (ARN) of the transit gateway.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transit_gateway_registration resource, the following permissions are required: + +### Read +
+networkmanager:GetTransitGatewayRegistrations
+ +### Delete +
+networkmanager:DeregisterTransitGateway,
+networkmanager:GetTransitGatewayRegistrations
+ + +## Example +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM awscc.networkmanager.transit_gateway_registration +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalNetworkId>' +AND data__Identifier = '<TransitGatewayArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registrations/index.md b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registrations/index.md new file mode 100644 index 0000000000..02b493061e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registrations/index.md @@ -0,0 +1,61 @@ +--- +title: transit_gateway_registrations +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_registrations + - 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 +--- +Retrieves a list of transit_gateway_registrations in a region + +## Overview + + + + + +
Nametransit_gateway_registrations
TypeResource
Descriptiontransit_gateway_registrations
Idawscc.networkmanager.transit_gateway_registrations
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
transit_gateway_arnstringThe Amazon Resource Name (ARN) of the transit gateway.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transit_gateway_registrations resource, the following permissions are required: + +### Create +
+networkmanager:RegisterTransitGateway,
+networkmanager:GetTransitGatewayRegistrations
+ +### List +
+networkmanager:GetTransitGatewayRegistrations
+ + +## Example +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM awscc.networkmanager.transit_gateway_registrations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachment/index.md b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachment/index.md new file mode 100644 index 0000000000..f879477b34 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachment/index.md @@ -0,0 +1,99 @@ +--- +title: transit_gateway_route_table_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_attachment + - 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 +--- +Gets an individual transit_gateway_route_table_attachment resource + +## Overview + + + + + +
Nametransit_gateway_route_table_attachment
TypeResource
Descriptiontransit_gateway_route_table_attachment
Idawscc.networkmanager.transit_gateway_route_table_attachment
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
peering_idstringThe Id of peering between transit gateway and core network.
transit_gateway_route_table_arnstringThe Arn of transit gateway route table.
core_network_idstringThe ID of a core network where you're creating a site-to-site VPN attachment.
core_network_arnstringThe ARN of a core network for the VPC attachment.
attachment_idstringThe ID of the attachment.
owner_account_idstringOwner account of the attachment.
attachment_typestringThe type of attachment.
statestringThe state of the attachment.
edge_locationstringThe Region where the edge is located.
resource_arnstringThe ARN of the Resource.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment that attachment is in.
proposed_segment_changeobjectThe attachment to move from one segment to another.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transit_gateway_route_table_attachment resource, the following permissions are required: + +### Read +
+networkmanager:GetTransitGatewayRouteTableAttachment
+ +### Update +
+networkmanager:GetTransitGatewayRouteTableAttachment,
+networkmanager:ListTagsForResource,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+ec2:DescribeRegions
+ +### Delete +
+networkmanager:GetTransitGatewayRouteTableAttachment,
+networkmanager:DeleteAttachment,
+ec2:DescribeRegions
+ + +## Example +```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, +tags +FROM awscc.networkmanager.transit_gateway_route_table_attachment +WHERE region = 'us-east-1' +AND data__Identifier = '<AttachmentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachments/index.md b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachments/index.md new file mode 100644 index 0000000000..e1cc8e748f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachments/index.md @@ -0,0 +1,62 @@ +--- +title: transit_gateway_route_table_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_attachments + - 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 +--- +Retrieves a list of transit_gateway_route_table_attachments in a region + +## Overview + + + + + +
Nametransit_gateway_route_table_attachments
TypeResource
Descriptiontransit_gateway_route_table_attachments
Idawscc.networkmanager.transit_gateway_route_table_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the transit_gateway_route_table_attachments resource, the following permissions are required: + +### Create +
+networkmanager:CreateTransitGatewayRouteTableAttachment,
+networkmanager:GetTransitGatewayRouteTableAttachment,
+networkmanager:TagResource,
+iam:CreateServiceLinkedRole,
+ec2:DescribeRegions
+ +### List +
+networkmanager:ListAttachments
+ + +## Example +```sql +SELECT +region, +attachment_id +FROM awscc.networkmanager.transit_gateway_route_table_attachments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md b/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md new file mode 100644 index 0000000000..d2756a2630 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md @@ -0,0 +1,103 @@ +--- +title: vpc_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_attachment + - 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 +--- +Gets an individual vpc_attachment resource + +## Overview + + + + + +
Namevpc_attachment
TypeResource
Descriptionvpc_attachment
Idawscc.networkmanager.vpc_attachment
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
core_network_idstringThe ID of a core network for the VPC attachment.
core_network_arnstringThe ARN of a core network for the VPC attachment.
attachment_idstringId of the attachment.
owner_account_idstringOwner account of the attachment.
attachment_typestringAttachment type.
statestringState of the attachment.
edge_locationstringThe Region where the edge is located.
vpc_arnstringThe ARN of the VPC.
resource_arnstringThe ARN of the Resource.
attachment_policy_rule_numberintegerThe policy rule number associated with the attachment.
segment_namestringThe name of the segment attachment..
proposed_segment_changeobjectThe attachment to move from one segment to another.
tagsarrayTags for the attachment.
created_atstringCreation time of the attachment.
updated_atstringLast update time of the attachment.
subnet_arnsarraySubnet Arn list
optionsobjectVpc options of the attachment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_attachment resource, the following permissions are required: + +### Read +
+networkmanager:GetVpcAttachment
+ +### Update +
+networkmanager:UpdateVpcAttachment,
+networkmanager:GetVpcAttachment,
+networkmanager:ListTagsForResource,
+networkmanager:TagResource,
+networkmanager:UntagResource,
+ec2:DescribeRegions
+ +### Delete +
+networkmanager:DeleteAttachment,
+networkmanager:GetVpcAttachment,
+networkmanager:UntagResource,
+ec2:DescribeRegions
+ + +## Example +```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, +tags, +created_at, +updated_at, +subnet_arns, +options +FROM awscc.networkmanager.vpc_attachment +WHERE region = 'us-east-1' +AND data__Identifier = '<AttachmentId>' +``` diff --git a/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md b/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md new file mode 100644 index 0000000000..4c9ccd8a5e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md @@ -0,0 +1,62 @@ +--- +title: vpc_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_attachments + - 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 +--- +Retrieves a list of vpc_attachments in a region + +## Overview + + + + + +
Namevpc_attachments
TypeResource
Descriptionvpc_attachments
Idawscc.networkmanager.vpc_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringId of the attachment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_attachments resource, the following permissions are required: + +### Create +
+networkmanager:CreateVpcAttachment,
+networkmanager:GetVpcAttachment,
+networkmanager:TagResource,
+ec2:DescribeRegions,
+iam:CreateServiceLinkedRole
+ +### List +
+networkmanager:ListAttachments
+ + +## Example +```sql +SELECT +region, +attachment_id +FROM awscc.networkmanager.vpc_attachments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/index.md new file mode 100644 index 0000000000..4818418bf3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/index.md @@ -0,0 +1,45 @@ +--- +title: nimblestudio +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The nimblestudio service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+launch_profile
+launch_profiles
+streaming_image
+streaming_images +
+
+studio
+studio_component
+studio_components
+studios +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/launch_profile/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/launch_profile/index.md new file mode 100644 index 0000000000..188ddb511f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/launch_profile/index.md @@ -0,0 +1,87 @@ +--- +title: launch_profile +hide_title: false +hide_table_of_contents: false +keywords: + - launch_profile + - 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 +--- +Gets an individual launch_profile resource + +## Overview + + + + + +
Namelaunch_profile
TypeResource
Descriptionlaunch_profile
Idawscc.nimblestudio.launch_profile
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring<p>The description.</p>
ec2_subnet_idsarray<p>Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.<br/> These subnets must support the specified instance types. </p>
launch_profile_idstring
launch_profile_protocol_versionsarray<p>The version number of the protocol that is used by the launch profile. The only valid<br/> version is "2021-03-31".</p>
namestring<p>The name for the launch profile.</p>
stream_configurationobject
studio_component_idsarray<p>Unique identifiers for a collection of studio components that can be used with this<br/> launch profile.</p>
studio_idstring<p>The studio ID. </p>
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the launch_profile resource, the following permissions are required: + +### Read +
+nimble:GetLaunchProfile
+ +### Update +
+nimble:UpdateLaunchProfile,
+nimble:GetLaunchProfile,
+ec2:CreateNetworkInterface,
+ec2:CreateNetworkInterfacePermission,
+ec2:DescribeSubnets,
+ec2:RunInstances
+ +### Delete +
+nimble:DeleteLaunchProfile,
+nimble:GetLaunchProfile,
+nimble:UntagResource
+ + +## Example +```sql +SELECT +region, +description, +ec2_subnet_ids, +launch_profile_id, +launch_profile_protocol_versions, +name, +stream_configuration, +studio_component_ids, +studio_id, +tags +FROM awscc.nimblestudio.launch_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<LaunchProfileId>' +AND data__Identifier = '<StudioId>' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md new file mode 100644 index 0000000000..e1882f5024 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md @@ -0,0 +1,66 @@ +--- +title: launch_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - launch_profiles + - 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 +--- +Retrieves a list of launch_profiles in a region + +## Overview + + + + + +
Namelaunch_profiles
TypeResource
Descriptionlaunch_profiles
Idawscc.nimblestudio.launch_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
launch_profile_idstring
studio_idstring<p>The studio ID. </p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the launch_profiles resource, the following permissions are required: + +### Create +
+nimble:CreateLaunchProfile,
+nimble:GetLaunchProfile,
+nimble:TagResource,
+ec2:CreateNetworkInterface,
+ec2:CreateNetworkInterfacePermission,
+ec2:RunInstances,
+ec2:DescribeSubnets
+ +### List +
+nimble:ListLaunchProfiles
+ + +## Example +```sql +SELECT +region, +launch_profile_id, +studio_id +FROM awscc.nimblestudio.launch_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md new file mode 100644 index 0000000000..620e94de65 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md @@ -0,0 +1,96 @@ +--- +title: streaming_image +hide_title: false +hide_table_of_contents: false +keywords: + - streaming_image + - 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 +--- +Gets an individual streaming_image resource + +## Overview + + + + + +
Namestreaming_image
TypeResource
Descriptionstreaming_image
Idawscc.nimblestudio.streaming_image
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring<p>A human-readable description of the streaming image.</p>
ec2_image_idstring<p>The ID of an EC2 machine image with which to create this streaming image.</p>
encryption_configurationobject
eula_idsarray<p>The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.</p>
namestring<p>A friendly name for a streaming image resource.</p>
ownerstring<p>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.</p>
platformstring<p>The platform of the streaming image, either WINDOWS or LINUX.</p>
streaming_image_idstring
studio_idstring<p>The studioId. </p>
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the streaming_image resource, the following permissions are required: + +### Read +
+nimble:GetStreamingImage
+ +### Update +
+nimble:UpdateStreamingImage,
+nimble:GetStreamingImage,
+kms:Encrypt,
+kms:Decrypt,
+kms:CreateGrant,
+kms:ListGrants,
+kms:GenerateDataKey
+ +### Delete +
+nimble:DeleteStreamingImage,
+nimble:GetStreamingImage,
+nimble:UntagResource,
+ec2:ModifyInstanceAttribute,
+ec2:ModifySnapshotAttribute,
+ec2:DeregisterImage,
+ec2:DeleteSnapshot,
+kms:ListGrants,
+kms:RetireGrant
+ + +## Example +```sql +SELECT +region, +description, +ec2_image_id, +encryption_configuration, +eula_ids, +name, +owner, +platform, +streaming_image_id, +studio_id, +tags +FROM awscc.nimblestudio.streaming_image +WHERE region = 'us-east-1' +AND data__Identifier = '<StudioId>' +AND data__Identifier = '<StreamingImageId>' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md new file mode 100644 index 0000000000..ab2fd5c698 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md @@ -0,0 +1,73 @@ +--- +title: streaming_images +hide_title: false +hide_table_of_contents: false +keywords: + - streaming_images + - 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 +--- +Retrieves a list of streaming_images in a region + +## Overview + + + + + +
Namestreaming_images
TypeResource
Descriptionstreaming_images
Idawscc.nimblestudio.streaming_images
+ +## Fields + + + + + + +
NameDatatypeDescription
studio_idstring<p>The studioId. </p>
streaming_image_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the streaming_images resource, the following permissions are required: + +### Create +
+nimble:CreateStreamingImage,
+nimble:GetStreamingImage,
+nimble:TagResource,
+ec2:DescribeImages,
+ec2:DescribeSnapshots,
+ec2:ModifyInstanceAttribute,
+ec2:ModifySnapshotAttribute,
+ec2:ModifyImageAttribute,
+ec2:RegisterImage,
+kms:Encrypt,
+kms:Decrypt,
+kms:CreateGrant,
+kms:ListGrants,
+kms:GenerateDataKey
+ +### List +
+nimble:ListStreamingImages
+ + +## Example +```sql +SELECT +region, +studio_id, +streaming_image_id +FROM awscc.nimblestudio.streaming_images +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md new file mode 100644 index 0000000000..0eae865322 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md @@ -0,0 +1,101 @@ +--- +title: studio +hide_title: false +hide_table_of_contents: false +keywords: + - studio + - 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 +--- +Gets an individual studio resource + +## Overview + + + + + +
Namestudio
TypeResource
Descriptionstudio
Idawscc.nimblestudio.studio
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
admin_role_arnstring<p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>
display_namestring<p>A friendly name for the studio.</p>
home_regionstring<p>The Amazon Web Services Region where the studio resource is located.</p>
sso_client_idstring<p>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.</p>
studio_encryption_configurationobject
studio_idstring
studio_namestring<p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>
studio_urlstring<p>The address of the web page for the studio.</p>
tagsobject
user_role_arnstring<p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studio resource, the following permissions are required: + +### Read +
+nimble:GetStudio,
+kms:Encrypt,
+kms:Decrypt,
+kms:ListGrants,
+kms:GenerateDataKey
+ +### Update +
+iam:PassRole,
+nimble:UpdateStudio,
+nimble:GetStudio,
+kms:Encrypt,
+kms:Decrypt,
+kms:CreateGrant,
+kms:ListGrants,
+kms:GenerateDataKey
+ +### Delete +
+nimble:DeleteStudio,
+nimble:GetStudio,
+nimble:UntagResource,
+kms:Encrypt,
+kms:Decrypt,
+kms:ListGrants,
+kms:RetireGrant,
+kms:GenerateDataKey,
+sso:DeleteManagedApplicationInstance,
+sso:GetManagedApplicationInstance
+ + +## Example +```sql +SELECT +region, +admin_role_arn, +display_name, +home_region, +sso_client_id, +studio_encryption_configuration, +studio_id, +studio_name, +studio_url, +tags, +user_role_arn +FROM awscc.nimblestudio.studio +WHERE region = 'us-east-1' +AND data__Identifier = '<StudioId>' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md new file mode 100644 index 0000000000..c2558f7f5f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md @@ -0,0 +1,97 @@ +--- +title: studio_component +hide_title: false +hide_table_of_contents: false +keywords: + - studio_component + - 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 +--- +Gets an individual studio_component resource + +## Overview + + + + + +
Namestudio_component
TypeResource
Descriptionstudio_component
Idawscc.nimblestudio.studio_component
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
configurationundefined
descriptionstring<p>The description.</p>
ec2_security_group_idsarray<p>The EC2 security groups that control access to the studio component.</p>
initialization_scriptsarray<p>Initialization scripts for studio components.</p>
namestring<p>The name for the studio component.</p>
runtime_role_arnstring
script_parametersarray<p>Parameters for the studio component scripts.</p>
secure_initialization_role_arnstring
studio_component_idstring
studio_idstring<p>The studio ID. </p>
subtypestring
tagsobject
typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studio_component resource, the following permissions are required: + +### Read +
+nimble:GetStudioComponent
+ +### Update +
+iam:PassRole,
+nimble:UpdateStudioComponent,
+nimble:GetStudioComponent,
+ds:AuthorizeApplication,
+ec2:DescribeSecurityGroups,
+fsx:DescribeFilesystems,
+ds:DescribeDirectories
+ +### Delete +
+nimble:DeleteStudioComponent,
+nimble:GetStudioComponent,
+nimble:UntagResource,
+ds:UnauthorizeApplication
+ + +## Example +```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, +tags, +type +FROM awscc.nimblestudio.studio_component +WHERE region = 'us-east-1' +AND data__Identifier = '<StudioComponentId>' +AND data__Identifier = '<StudioId>' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md new file mode 100644 index 0000000000..cf97190d5d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md @@ -0,0 +1,67 @@ +--- +title: studio_components +hide_title: false +hide_table_of_contents: false +keywords: + - studio_components + - 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 +--- +Retrieves a list of studio_components in a region + +## Overview + + + + + +
Namestudio_components
TypeResource
Descriptionstudio_components
Idawscc.nimblestudio.studio_components
+ +## Fields + + + + + + +
NameDatatypeDescription
studio_component_idstring
studio_idstring<p>The studio ID. </p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studio_components resource, the following permissions are required: + +### Create +
+iam:PassRole,
+nimble:CreateStudioComponent,
+nimble:GetStudioComponent,
+nimble:TagResource,
+ds:AuthorizeApplication,
+ec2:DescribeSecurityGroups,
+fsx:DescribeFilesystems,
+ds:DescribeDirectories
+ +### List +
+nimble:ListStudioComponents
+ + +## Example +```sql +SELECT +region, +studio_component_id, +studio_id +FROM awscc.nimblestudio.studio_components +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md new file mode 100644 index 0000000000..b643f146ab --- /dev/null +++ b/docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md @@ -0,0 +1,67 @@ +--- +title: studios +hide_title: false +hide_table_of_contents: false +keywords: + - studios + - 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 +--- +Retrieves a list of studios in a region + +## Overview + + + + + +
Namestudios
TypeResource
Descriptionstudios
Idawscc.nimblestudio.studios
+ +## Fields + + + + + +
NameDatatypeDescription
studio_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the studios resource, the following permissions are required: + +### Create +
+iam:PassRole,
+nimble:CreateStudio,
+nimble:GetStudio,
+nimble:TagResource,
+sso:CreateManagedApplicationInstance,
+kms:Encrypt,
+kms:Decrypt,
+kms:CreateGrant,
+kms:ListGrants,
+kms:GenerateDataKey
+ +### List +
+nimble:ListStudios
+ + +## Example +```sql +SELECT +region, +studio_id +FROM awscc.nimblestudio.studios +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/oam/index.md b/docs/awscc-docs/providers/awscc/oam/index.md new file mode 100644 index 0000000000..92a1604598 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/oam/index.md @@ -0,0 +1,41 @@ +--- +title: oam +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The oam service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+link
+links +
+
+sink
+sinks +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/oam/link/index.md b/docs/awscc-docs/providers/awscc/oam/link/index.md new file mode 100644 index 0000000000..0058a48844 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/oam/link/index.md @@ -0,0 +1,81 @@ +--- +title: link +hide_title: false +hide_table_of_contents: false +keywords: + - link + - 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 +--- +Gets an individual link resource + +## Overview + + + + + +
Namelink
TypeResource
Descriptionlink
Idawscc.oam.link
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
labelstring
label_templatestring
resource_typesarray
sink_identifierstring
tagsobjectTags to apply to the link
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the link resource, the following permissions are required: + +### Read +
+oam:GetLink
+ +### Update +
+oam:GetLink,
+oam:UpdateLink,
+cloudwatch:Link,
+logs:Link,
+xray:Link,
+applicationinsights:Link,
+oam:TagResource,
+oam:UntagResource
+ +### Delete +
+oam:DeleteLink,
+oam:GetLink
+ + +## Example +```sql +SELECT +region, +arn, +label, +label_template, +resource_types, +sink_identifier, +tags +FROM awscc.oam.link +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/oam/links/index.md b/docs/awscc-docs/providers/awscc/oam/links/index.md new file mode 100644 index 0000000000..22e1508428 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/oam/links/index.md @@ -0,0 +1,63 @@ +--- +title: links +hide_title: false +hide_table_of_contents: false +keywords: + - links + - 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 +--- +Retrieves a list of links in a region + +## Overview + + + + + +
Namelinks
TypeResource
Descriptionlinks
Idawscc.oam.links
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the links resource, the following permissions are required: + +### Create +
+oam:CreateLink,
+oam:GetLink,
+cloudwatch:Link,
+logs:Link,
+xray:Link,
+applicationinsights:Link
+ +### List +
+oam:ListLinks
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.oam.links +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/oam/sink/index.md b/docs/awscc-docs/providers/awscc/oam/sink/index.md new file mode 100644 index 0000000000..2d8ee1992a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/oam/sink/index.md @@ -0,0 +1,76 @@ +--- +title: sink +hide_title: false +hide_table_of_contents: false +keywords: + - sink + - 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 +--- +Gets an individual sink resource + +## Overview + + + + + +
Namesink
TypeResource
Descriptionsink
Idawscc.oam.sink
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
namestringThe name of the ObservabilityAccessManager Sink.
policyobjectThe policy of this ObservabilityAccessManager Sink.
tagsobjectTags to apply to the sink
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sink resource, the following permissions are required: + +### Delete +
+oam:DeleteSink,
+oam:GetSinkPolicy,
+oam:GetSink
+ +### Read +
+oam:GetSinkPolicy,
+oam:GetSink
+ +### Update +
+oam:PutSinkPolicy,
+oam:GetSinkPolicy,
+oam:GetSink,
+oam:TagResource,
+oam:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +name, +policy, +tags +FROM awscc.oam.sink +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/oam/sinks/index.md b/docs/awscc-docs/providers/awscc/oam/sinks/index.md new file mode 100644 index 0000000000..9c0ee41ecd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/oam/sinks/index.md @@ -0,0 +1,61 @@ +--- +title: sinks +hide_title: false +hide_table_of_contents: false +keywords: + - sinks + - 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 +--- +Retrieves a list of sinks in a region + +## Overview + + + + + +
Namesinks
TypeResource
Descriptionsinks
Idawscc.oam.sinks
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sinks resource, the following permissions are required: + +### Create +
+oam:CreateSink,
+oam:PutSinkPolicy,
+oam:GetSinkPolicy,
+oam:GetSink
+ +### List +
+oam:ListSinks
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.oam.sinks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/annotation_store/index.md b/docs/awscc-docs/providers/awscc/omics/annotation_store/index.md new file mode 100644 index 0000000000..a0778de43c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/annotation_store/index.md @@ -0,0 +1,94 @@ +--- +title: annotation_store +hide_title: false +hide_table_of_contents: false +keywords: + - annotation_store + - 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 +--- +Gets an individual annotation_store resource + +## Overview + + + + + +
Nameannotation_store
TypeResource
Descriptionannotation_store
Idawscc.omics.annotation_store
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
creation_timestring
descriptionstring
idstring
namestring
referenceobject
sse_configobject
statusstring
status_messagestring
store_arnstring
store_formatstring
store_optionsundefined
store_size_bytesnumber
tagsobject
update_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the annotation_store resource, the following permissions are required: + +### Read +
+omics:GetAnnotationStore
+ +### Update +
+omics:UpdateAnnotationStore,
+omics:TagResource,
+omics:UntagResource,
+omics:GetAnnotationStore,
+omics:ListTagsForResource
+ +### Delete +
+omics:DeleteAnnotationStore,
+omics:ListAnnotationStores
+ + +## Example +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_format, +store_options, +store_size_bytes, +tags, +update_time +FROM awscc.omics.annotation_store +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md b/docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md new file mode 100644 index 0000000000..806a3feb80 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md @@ -0,0 +1,65 @@ +--- +title: annotation_stores +hide_title: false +hide_table_of_contents: false +keywords: + - annotation_stores + - 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 +--- +Retrieves a list of annotation_stores in a region + +## Overview + + + + + +
Nameannotation_stores
TypeResource
Descriptionannotation_stores
Idawscc.omics.annotation_stores
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the annotation_stores resource, the following permissions are required: + +### Create +
+omics:CreateAnnotationStore,
+omics:TagResource,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:CreateGrant,
+ram:AcceptResourceShareInvitation,
+ram:GetResourceShareInvitations,
+omics:GetAnnotationStore
+ +### List +
+omics:ListAnnotationStores
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.omics.annotation_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/index.md b/docs/awscc-docs/providers/awscc/omics/index.md new file mode 100644 index 0000000000..56ec3b8a8c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/index.md @@ -0,0 +1,49 @@ +--- +title: omics +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The omics service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+annotation_store
+annotation_stores
+reference_store
+reference_stores
+run_group
+run_groups +
+
+sequence_store
+sequence_stores
+variant_store
+variant_stores
+workflow
+workflows +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/omics/reference_store/index.md b/docs/awscc-docs/providers/awscc/omics/reference_store/index.md new file mode 100644 index 0000000000..d56d6cea34 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/reference_store/index.md @@ -0,0 +1,72 @@ +--- +title: reference_store +hide_title: false +hide_table_of_contents: false +keywords: + - reference_store + - 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 +--- +Gets an individual reference_store resource + +## Overview + + + + + +
Namereference_store
TypeResource
Descriptionreference_store
Idawscc.omics.reference_store
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe store's ARN.
creation_timestringWhen the store was created.
descriptionstringA description for the store.
namestringA name for the store.
reference_store_idstring
sse_configobject
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the reference_store resource, the following permissions are required: + +### Read +
+omics:GetReferenceStore,
+omics:ListTagsForResource
+ +### Delete +
+omics:DeleteReferenceStore
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +description, +name, +reference_store_id, +sse_config, +tags +FROM awscc.omics.reference_store +WHERE region = 'us-east-1' +AND data__Identifier = '<ReferenceStoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/reference_stores/index.md b/docs/awscc-docs/providers/awscc/omics/reference_stores/index.md new file mode 100644 index 0000000000..22017ed7e9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/reference_stores/index.md @@ -0,0 +1,59 @@ +--- +title: reference_stores +hide_title: false +hide_table_of_contents: false +keywords: + - reference_stores + - 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 +--- +Retrieves a list of reference_stores in a region + +## Overview + + + + + +
Namereference_stores
TypeResource
Descriptionreference_stores
Idawscc.omics.reference_stores
+ +## Fields + + + + + +
NameDatatypeDescription
reference_store_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the reference_stores resource, the following permissions are required: + +### Create +
+omics:CreateReferenceStore,
+omics:TagResource
+ +### List +
+omics:ListReferenceStores
+ + +## Example +```sql +SELECT +region, +reference_store_id +FROM awscc.omics.reference_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/run_group/index.md b/docs/awscc-docs/providers/awscc/omics/run_group/index.md new file mode 100644 index 0000000000..330b9abd70 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/run_group/index.md @@ -0,0 +1,84 @@ +--- +title: run_group +hide_title: false +hide_table_of_contents: false +keywords: + - run_group + - 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 +--- +Gets an individual run_group resource + +## Overview + + + + + +
Namerun_group
TypeResource
Descriptionrun_group
Idawscc.omics.run_group
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
idstring
max_cpusnumber
max_gpusnumber
max_durationnumber
max_runsnumber
namestring
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the run_group resource, the following permissions are required: + +### Read +
+omics:GetRunGroup
+ +### Update +
+omics:UpdateRunGroup,
+omics:TagResource,
+omics:GetRunGroup,
+omics:ListTagsForResource,
+omics:UntagResource
+ +### Delete +
+omics:DeleteRunGroup,
+omics:GetRunGroup
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +id, +max_cpus, +max_gpus, +max_duration, +max_runs, +name, +tags +FROM awscc.omics.run_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/run_groups/index.md b/docs/awscc-docs/providers/awscc/omics/run_groups/index.md new file mode 100644 index 0000000000..793841b3a8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/run_groups/index.md @@ -0,0 +1,59 @@ +--- +title: run_groups +hide_title: false +hide_table_of_contents: false +keywords: + - run_groups + - 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 +--- +Retrieves a list of run_groups in a region + +## Overview + + + + + +
Namerun_groups
TypeResource
Descriptionrun_groups
Idawscc.omics.run_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the run_groups resource, the following permissions are required: + +### Create +
+omics:CreateRunGroup,
+omics:TagResource
+ +### List +
+omics:ListRunGroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.omics.run_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/sequence_store/index.md b/docs/awscc-docs/providers/awscc/omics/sequence_store/index.md new file mode 100644 index 0000000000..cdc599aa00 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/sequence_store/index.md @@ -0,0 +1,74 @@ +--- +title: sequence_store +hide_title: false +hide_table_of_contents: false +keywords: + - sequence_store + - 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 +--- +Gets an individual sequence_store resource + +## Overview + + + + + +
Namesequence_store
TypeResource
Descriptionsequence_store
Idawscc.omics.sequence_store
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe store's ARN.
creation_timestringWhen the store was created.
descriptionstringA description for the store.
namestringA name for the store.
fallback_locationstringAn S3 URI representing the bucket and folder to store failed read set uploads.
sequence_store_idstring
sse_configobject
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sequence_store resource, the following permissions are required: + +### Read +
+omics:GetSequenceStore,
+omics:ListTagsForResource
+ +### Delete +
+omics:DeleteSequenceStore
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +description, +name, +fallback_location, +sequence_store_id, +sse_config, +tags +FROM awscc.omics.sequence_store +WHERE region = 'us-east-1' +AND data__Identifier = '<SequenceStoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md b/docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md new file mode 100644 index 0000000000..d493aa8729 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md @@ -0,0 +1,59 @@ +--- +title: sequence_stores +hide_title: false +hide_table_of_contents: false +keywords: + - sequence_stores + - 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 +--- +Retrieves a list of sequence_stores in a region + +## Overview + + + + + +
Namesequence_stores
TypeResource
Descriptionsequence_stores
Idawscc.omics.sequence_stores
+ +## Fields + + + + + +
NameDatatypeDescription
sequence_store_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sequence_stores resource, the following permissions are required: + +### Create +
+omics:CreateSequenceStore,
+omics:TagResource
+ +### List +
+omics:ListSequenceStores
+ + +## Example +```sql +SELECT +region, +sequence_store_id +FROM awscc.omics.sequence_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/variant_store/index.md b/docs/awscc-docs/providers/awscc/omics/variant_store/index.md new file mode 100644 index 0000000000..5537251cc0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/variant_store/index.md @@ -0,0 +1,90 @@ +--- +title: variant_store +hide_title: false +hide_table_of_contents: false +keywords: + - variant_store + - 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 +--- +Gets an individual variant_store resource + +## Overview + + + + + +
Namevariant_store
TypeResource
Descriptionvariant_store
Idawscc.omics.variant_store
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
creation_timestring
descriptionstring
idstring
namestring
referenceobject
sse_configobject
statusstring
status_messagestring
store_arnstring
store_size_bytesnumber
tagsobject
update_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the variant_store resource, the following permissions are required: + +### Read +
+omics:GetVariantStore
+ +### Update +
+omics:UpdateVariantStore,
+omics:TagResource,
+omics:UntagResource,
+omics:ListTagsForResource,
+omics:GetVariantStore
+ +### Delete +
+omics:DeleteVariantStore,
+omics:ListVariantStores
+ + +## Example +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_size_bytes, +tags, +update_time +FROM awscc.omics.variant_store +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/variant_stores/index.md b/docs/awscc-docs/providers/awscc/omics/variant_stores/index.md new file mode 100644 index 0000000000..752bb63df2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/variant_stores/index.md @@ -0,0 +1,65 @@ +--- +title: variant_stores +hide_title: false +hide_table_of_contents: false +keywords: + - variant_stores + - 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 +--- +Retrieves a list of variant_stores in a region + +## Overview + + + + + +
Namevariant_stores
TypeResource
Descriptionvariant_stores
Idawscc.omics.variant_stores
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the variant_stores resource, the following permissions are required: + +### Create +
+omics:CreateVariantStore,
+omics:TagResource,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:CreateGrant,
+ram:AcceptResourceShareInvitation,
+ram:GetResourceShareInvitations,
+omics:GetVariantStore
+ +### List +
+omics:ListVariantStores
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.omics.variant_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/workflow/index.md b/docs/awscc-docs/providers/awscc/omics/workflow/index.md new file mode 100644 index 0000000000..9b6a84cb6d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/workflow/index.md @@ -0,0 +1,94 @@ +--- +title: workflow +hide_title: false +hide_table_of_contents: false +keywords: + - workflow + - 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 +--- +Gets an individual workflow resource + +## Overview + + + + + +
Nameworkflow
TypeResource
Descriptionworkflow
Idawscc.omics.workflow
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
definition_uristring
descriptionstring
enginestring
idstring
mainstring
namestring
parameter_templateobject
statusstring
acceleratorsstring
storage_capacitynumber
tagsobject
typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workflow resource, the following permissions are required: + +### Read +
+omics:GetWorkflow
+ +### Update +
+omics:UpdateWorkflow,
+omics:GetWorkflow,
+omics:TagResource,
+omics:ListTagsForResource,
+omics:UntagResource
+ +### Delete +
+omics:DeleteWorkflow,
+omics:GetWorkflow
+ + +## Example +```sql +SELECT +region, +arn, +creation_time, +definition_uri, +description, +engine, +id, +main, +name, +parameter_template, +status, +accelerators, +storage_capacity, +tags, +type +FROM awscc.omics.workflow +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/omics/workflows/index.md b/docs/awscc-docs/providers/awscc/omics/workflows/index.md new file mode 100644 index 0000000000..86cd36b0d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/omics/workflows/index.md @@ -0,0 +1,70 @@ +--- +title: workflows +hide_title: false +hide_table_of_contents: false +keywords: + - workflows + - 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 +--- +Retrieves a list of workflows in a region + +## Overview + + + + + +
Nameworkflows
TypeResource
Descriptionworkflows
Idawscc.omics.workflows
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +
+omics:CreateWorkflow,
+omics:GetWorkflow,
+omics:TagResource,
+s3:PutObject,
+s3:GetObject,
+s3:GetObjectAttributes,
+s3:HeadObject,
+s3:GetEncryptionConfiguration,
+kms:Decrypt,
+kms:GenerateDataKey,
+kms:GenerateDataKeyPair,
+kms:GenerateDataKeyPairWithoutPlaintext,
+kms:GenerateDataKeyWithoutPlaintext
+ +### List +
+omics:ListWorkflows
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.omics.workflows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md new file mode 100644 index 0000000000..a03cf8a0a1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md @@ -0,0 +1,61 @@ +--- +title: access_policies +hide_title: false +hide_table_of_contents: false +keywords: + - access_policies + - 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 +--- +Retrieves a list of access_policies in a region + +## Overview + + + + + +
Nameaccess_policies
TypeResource
Descriptionaccess_policies
Idawscc.opensearchserverless.access_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_policies resource, the following permissions are required: + +### Create +
+aoss:CreateAccessPolicy,
+aoss:GetAccessPolicy
+ +### List +
+aoss:ListAccessPolicies
+ + +## Example +```sql +SELECT +region, +type, +name +FROM awscc.opensearchserverless.access_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md new file mode 100644 index 0000000000..0470d9b606 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md @@ -0,0 +1,72 @@ +--- +title: access_policy +hide_title: false +hide_table_of_contents: false +keywords: + - access_policy + - 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 +--- +Gets an individual access_policy resource + +## Overview + + + + + +
Nameaccess_policy
TypeResource
Descriptionaccess_policy
Idawscc.opensearchserverless.access_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringThe name of the policy
typestring
descriptionstringThe description of the policy
policystringThe JSON policy document that is the content for the policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_policy resource, the following permissions are required: + +### Read +
+aoss:GetAccessPolicy
+ +### Update +
+aoss:UpdateAccessPolicy,
+aoss:GetAccessPolicy
+ +### Delete +
+aoss:DeleteAccessPolicy,
+aoss:GetAccessPolicy
+ + +## Example +```sql +SELECT +region, +name, +type, +description, +policy +FROM awscc.opensearchserverless.access_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Type>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md new file mode 100644 index 0000000000..f83730bc5d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md @@ -0,0 +1,81 @@ +--- +title: collection +hide_title: false +hide_table_of_contents: false +keywords: + - collection + - 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 +--- +Gets an individual collection resource + +## Overview + + + + + +
Namecollection
TypeResource
Descriptioncollection
Idawscc.opensearchserverless.collection
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the collection
idstringThe identifier of the collection
namestringThe name of the collection.<br/><br/>The name must meet the following criteria:<br/>Unique to your account and AWS Region<br/>Starts with a lowercase letter<br/>Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)<br/>Contains between 3 and 32 characters<br/>
tagsarrayList of tags to be added to the resource
arnstringThe Amazon Resource Name (ARN) of the collection.
collection_endpointstringThe endpoint for the collection.
dashboard_endpointstringThe OpenSearch Dashboards endpoint for the collection.
typestring
standby_replicasstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the collection resource, the following permissions are required: + +### Delete +
+aoss:DeleteCollection,
+aoss:BatchGetCollection
+ +### Read +
+aoss:BatchGetCollection
+ +### Update +
+aoss:UpdateCollection,
+aoss:BatchGetCollection
+ + +## Example +```sql +SELECT +region, +description, +id, +name, +tags, +arn, +collection_endpoint, +dashboard_endpoint, +type, +standby_replicas +FROM awscc.opensearchserverless.collection +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md new file mode 100644 index 0000000000..5b0bb8d5c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md @@ -0,0 +1,60 @@ +--- +title: collections +hide_title: false +hide_table_of_contents: false +keywords: + - collections + - 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 +--- +Retrieves a list of collections in a region + +## Overview + + + + + +
Namecollections
TypeResource
Descriptioncollections
Idawscc.opensearchserverless.collections
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe identifier of the collection
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the collections resource, the following permissions are required: + +### Create +
+aoss:CreateCollection,
+aoss:BatchGetCollection,
+iam:CreateServiceLinkedRole
+ +### List +
+aoss:ListCollections
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.opensearchserverless.collections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/index.md new file mode 100644 index 0000000000..a34831c60f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/index.md @@ -0,0 +1,49 @@ +--- +title: opensearchserverless +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The opensearchserverless service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+access_policies
+access_policy
+collection
+collections
+lifecycle_policies
+lifecycle_policy +
+
+security_config
+security_configs
+security_policies
+security_policy
+vpc_endpoint
+vpc_endpoints +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policies/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policies/index.md new file mode 100644 index 0000000000..1730daef5d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policies/index.md @@ -0,0 +1,60 @@ +--- +title: lifecycle_policies +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policies + - 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 +--- +Retrieves a list of lifecycle_policies in a region + +## Overview + + + + + +
Namelifecycle_policies
TypeResource
Descriptionlifecycle_policies
Idawscc.opensearchserverless.lifecycle_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the lifecycle_policies resource, the following permissions are required: + +### Create +
+aoss:CreateLifecyclePolicy
+ +### List +
+aoss:ListLifecyclePolicies
+ + +## Example +```sql +SELECT +region, +type, +name +FROM awscc.opensearchserverless.lifecycle_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md new file mode 100644 index 0000000000..f3aaa81409 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md @@ -0,0 +1,71 @@ +--- +title: lifecycle_policy +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policy + - 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 +--- +Gets an individual lifecycle_policy resource + +## Overview + + + + + +
Namelifecycle_policy
TypeResource
Descriptionlifecycle_policy
Idawscc.opensearchserverless.lifecycle_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringThe name of the policy
typestring
descriptionstringThe description of the policy
policystringThe JSON policy document that is the content for the policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the lifecycle_policy resource, the following permissions are required: + +### Read +
+aoss:BatchGetLifecyclePolicy
+ +### Update +
+aoss:UpdateLifecyclePolicy,
+aoss:BatchGetLifecyclePolicy
+ +### Delete +
+aoss:DeleteLifecyclePolicy
+ + +## Example +```sql +SELECT +region, +name, +type, +description, +policy +FROM awscc.opensearchserverless.lifecycle_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Type>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md new file mode 100644 index 0000000000..63738bc225 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md @@ -0,0 +1,72 @@ +--- +title: security_config +hide_title: false +hide_table_of_contents: false +keywords: + - security_config + - 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 +--- +Gets an individual security_config resource + +## Overview + + + + + +
Namesecurity_config
TypeResource
Descriptionsecurity_config
Idawscc.opensearchserverless.security_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstringSecurity config description
idstringThe identifier of the security config
namestringThe friendly name of the security config
saml_optionsobject
typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_config resource, the following permissions are required: + +### Read +
+aoss:GetSecurityConfig
+ +### Update +
+aoss:GetSecurityConfig,
+aoss:UpdateSecurityConfig
+ +### Delete +
+aoss:DeleteSecurityConfig
+ + +## Example +```sql +SELECT +region, +description, +id, +name, +saml_options, +type +FROM awscc.opensearchserverless.security_config +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md new file mode 100644 index 0000000000..b3b3d65933 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md @@ -0,0 +1,58 @@ +--- +title: security_configs +hide_title: false +hide_table_of_contents: false +keywords: + - security_configs + - 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 +--- +Retrieves a list of security_configs in a region + +## Overview + + + + + +
Namesecurity_configs
TypeResource
Descriptionsecurity_configs
Idawscc.opensearchserverless.security_configs
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe identifier of the security config
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_configs resource, the following permissions are required: + +### Create +
+aoss:CreateSecurityConfig
+ +### List +
+aoss:ListSecurityConfigs
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.opensearchserverless.security_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md new file mode 100644 index 0000000000..eb0670c6f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md @@ -0,0 +1,63 @@ +--- +title: security_policies +hide_title: false +hide_table_of_contents: false +keywords: + - security_policies + - 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 +--- +Retrieves a list of security_policies in a region + +## Overview + + + + + +
Namesecurity_policies
TypeResource
Descriptionsecurity_policies
Idawscc.opensearchserverless.security_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_policies resource, the following permissions are required: + +### Create +
+aoss:GetSecurityPolicy,
+aoss:CreateSecurityPolicy,
+kms:DescribeKey,
+kms:CreateGrant
+ +### List +
+aoss:ListSecurityPolicies
+ + +## Example +```sql +SELECT +region, +type, +name +FROM awscc.opensearchserverless.security_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md new file mode 100644 index 0000000000..88092edac9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md @@ -0,0 +1,75 @@ +--- +title: security_policy +hide_title: false +hide_table_of_contents: false +keywords: + - security_policy + - 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 +--- +Gets an individual security_policy resource + +## Overview + + + + + +
Namesecurity_policy
TypeResource
Descriptionsecurity_policy
Idawscc.opensearchserverless.security_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the policy
policystringThe JSON policy document that is the content for the policy
namestringThe name of the policy
typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the security_policy resource, the following permissions are required: + +### Update +
+aoss:GetSecurityPolicy,
+aoss:UpdateSecurityPolicy,
+kms:DescribeKey,
+kms:CreateGrant
+ +### Delete +
+aoss:GetSecurityPolicy,
+aoss:DeleteSecurityPolicy
+ +### Read +
+aoss:GetSecurityPolicy,
+kms:DescribeKey
+ + +## Example +```sql +SELECT +region, +description, +policy, +name, +type +FROM awscc.opensearchserverless.security_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Type>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md new file mode 100644 index 0000000000..7546402a87 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md @@ -0,0 +1,105 @@ +--- +title: vpc_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint + - 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 +--- +Gets an individual vpc_endpoint resource + +## Overview + + + + + +
Namevpc_endpoint
TypeResource
Descriptionvpc_endpoint
Idawscc.opensearchserverless.vpc_endpoint
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstringThe identifier of the VPC Endpoint
namestringThe name of the VPC Endpoint
security_group_idsarrayThe ID of one or more security groups to associate with the endpoint network interface
subnet_idsarrayThe ID of one or more subnets in which to create an endpoint network interface
vpc_idstringThe ID of the VPC in which the endpoint will be used.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_endpoint resource, the following permissions are required: + +### Read +
+aoss:BatchGetVpcEndpoint,
+ec2:DescribeVpcEndpoints
+ +### Update +
+aoss:BatchGetVpcEndpoint,
+aoss:UpdateVpcEndpoint,
+ec2:CreateVpcEndpoint,
+ec2:DeleteVpcEndPoints,
+ec2:DescribeVpcEndpoints,
+ec2:ModifyVpcEndPoint,
+ec2:DescribeVpcs,
+ec2:DescribeSubnets,
+ec2:DescribeSecurityGroups,
+ec2:CreateTags,
+route53:ChangeResourceRecordSets,
+route53:GetChange,
+route53:GetHostedZone,
+route53:ListResourceRecordSets,
+route53:ListHostedZonesByName,
+route53:CreateHostedZone,
+route53:ListHostedZonesByVPC,
+route53:AssociateVPCWithHostedZone
+ +### Delete +
+aoss:BatchGetVpcEndpoint,
+aoss:DeleteVpcEndpoint,
+ec2:DeleteVpcEndPoints,
+ec2:DescribeVpcEndpoints,
+ec2:ModifyVpcEndPoint,
+ec2:DescribeVpcs,
+ec2:DescribeSubnets,
+ec2:DescribeSecurityGroups,
+ec2:CreateTags,
+route53:ChangeResourceRecordSets,
+route53:DeleteHostedZone,
+route53:GetChange,
+route53:GetHostedZone,
+route53:ListResourceRecordSets,
+route53:ListHostedZonesByName,
+route53:ListHostedZonesByVPC,
+route53:AssociateVPCWithHostedZone
+ + +## Example +```sql +SELECT +region, +id, +name, +security_group_ids, +subnet_ids, +vpc_id +FROM awscc.opensearchserverless.vpc_endpoint +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md new file mode 100644 index 0000000000..77a6f6a078 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md @@ -0,0 +1,76 @@ +--- +title: vpc_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoints + - 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 +--- +Retrieves a list of vpc_endpoints in a region + +## Overview + + + + + +
Namevpc_endpoints
TypeResource
Descriptionvpc_endpoints
Idawscc.opensearchserverless.vpc_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe identifier of the VPC Endpoint
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_endpoints resource, the following permissions are required: + +### Create +
+aoss:BatchGetVpcEndpoint,
+aoss:CreateVpcEndpoint,
+ec2:CreateVpcEndpoint,
+ec2:DeleteVpcEndPoints,
+ec2:DescribeVpcEndpoints,
+ec2:ModifyVpcEndPoint,
+ec2:DescribeVpcs,
+ec2:DescribeSubnets,
+ec2:DescribeSecurityGroups,
+ec2:CreateTags,
+route53:ChangeResourceRecordSets,
+route53:GetChange,
+route53:GetHostedZone,
+route53:ListResourceRecordSets,
+route53:ListHostedZonesByName,
+route53:CreateHostedZone,
+route53:ListHostedZonesByVPC,
+route53:AssociateVPCWithHostedZone
+ +### List +
+aoss:ListVpcEndpoints,
+ec2:DescribeVpcEndpoints
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.opensearchserverless.vpc_endpoints +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md b/docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md new file mode 100644 index 0000000000..cb00f5502e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md @@ -0,0 +1,119 @@ +--- +title: domain +hide_title: false +hide_table_of_contents: false +keywords: + - domain + - opensearchservice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual domain resource + +## Overview + + + + + +
Namedomain
TypeResource
Descriptiondomain
Idawscc.opensearchservice.domain
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_configobject
domain_namestring
access_policiesobject
i_paddress_typestring
engine_versionstring
advanced_optionsobject
log_publishing_optionsobject
snapshot_optionsobject
v_pc_optionsobject
node_to_node_encryption_optionsobject
domain_endpoint_optionsobject
cognito_optionsobject
advanced_security_optionsobject
domain_endpointstring
domain_endpoint_v2string
domain_endpointsobject
e_bs_optionsobject
idstring
arnstring
domain_arnstring
encryption_at_rest_optionsobject
tagsarrayAn arbitrary set of tags (key-value pairs) for this Domain.
service_software_optionsobject
off_peak_window_optionsobject
software_update_optionsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +
+es:DescribeDomain,
+es:ListTags
+ +### Update +
+es:UpdateDomain,
+es:UpgradeDomain,
+es:DescribeDomain,
+es:AddTags,
+es:RemoveTags,
+es:ListTags,
+es:DescribeDomainChangeProgress
+ +### Delete +
+es:DeleteDomain,
+es:DescribeDomain
+ + +## Example +```sql +SELECT +region, +cluster_config, +domain_name, +access_policies, +i_paddress_type, +engine_version, +advanced_options, +log_publishing_options, +snapshot_options, +v_pc_options, +node_to_node_encryption_options, +domain_endpoint_options, +cognito_options, +advanced_security_options, +domain_endpoint, +domain_endpoint_v2, +domain_endpoints, +e_bs_options, +id, +arn, +domain_arn, +encryption_at_rest_options, +tags, +service_software_options, +off_peak_window_options, +software_update_options +FROM awscc.opensearchservice.domain +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainName>' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchservice/domains/index.md b/docs/awscc-docs/providers/awscc/opensearchservice/domains/index.md new file mode 100644 index 0000000000..23f3e9b03e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchservice/domains/index.md @@ -0,0 +1,57 @@ +--- +title: domains +hide_title: false +hide_table_of_contents: false +keywords: + - domains + - opensearchservice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of domains in a region + +## Overview + + + + + +
Namedomains
TypeResource
Descriptiondomains
Idawscc.opensearchservice.domains
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +
+es:CreateDomain,
+es:DescribeDomain,
+es:AddTags,
+es:ListTags
+ + +## Example +```sql +SELECT +region, +domain_name +FROM awscc.opensearchservice.domains +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/opensearchservice/index.md b/docs/awscc-docs/providers/awscc/opensearchservice/index.md new file mode 100644 index 0000000000..e0c9b4646c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opensearchservice/index.md @@ -0,0 +1,39 @@ +--- +title: opensearchservice +hide_title: false +hide_table_of_contents: false +keywords: + - opensearchservice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The opensearchservice service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+domain +
+
+domains +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/opsworkscm/index.md b/docs/awscc-docs/providers/awscc/opsworkscm/index.md new file mode 100644 index 0000000000..b0887e2d00 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opsworkscm/index.md @@ -0,0 +1,39 @@ +--- +title: opsworkscm +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The opsworkscm service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+server +
+
+servers +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/opsworkscm/server/index.md b/docs/awscc-docs/providers/awscc/opsworkscm/server/index.md new file mode 100644 index 0000000000..e759249c05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opsworkscm/server/index.md @@ -0,0 +1,111 @@ +--- +title: server +hide_title: false +hide_table_of_contents: false +keywords: + - server + - 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 +--- +Gets an individual server resource + +## Overview + + + + + +
Nameserver
TypeResource
Descriptionserver
Idawscc.opsworkscm.server
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
key_pairstring
engine_versionstring
service_role_arnstring
disable_automated_backupboolean
backup_idstring
engine_modelstring
preferred_maintenance_windowstring
associate_public_ip_addressboolean
instance_profile_arnstring
custom_certificatestring
preferred_backup_windowstring
security_group_idsarray
subnet_idsarray
custom_domainstring
endpointstring
custom_private_keystring
server_namestring
engine_attributesarray
backup_retention_countinteger
arnstring
instance_typestring
tagsarray
enginestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the server resource, the following permissions are required: + +### Delete +
+opsworks-cm:DeleteServer,
+opsworks-cm:DescribeServers
+ +### Update +
+opsworks-cm:UpdateServer,
+opsworks-cm:TagResource,
+opsworks-cm:UntagResource,
+opsworks-cm:DescribeServers
+ +### Read +
+opsworks-cm:DescribeServers
+ + +## Example +```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, +tags, +engine +FROM awscc.opsworkscm.server +WHERE region = 'us-east-1' +AND data__Identifier = '<ServerName>' +``` diff --git a/docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md b/docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md new file mode 100644 index 0000000000..22d26f5345 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md @@ -0,0 +1,61 @@ +--- +title: servers +hide_title: false +hide_table_of_contents: false +keywords: + - servers + - 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 +--- +Retrieves a list of servers in a region + +## Overview + + + + + +
Nameservers
TypeResource
Descriptionservers
Idawscc.opsworkscm.servers
+ +## Fields + + + + + +
NameDatatypeDescription
server_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the servers resource, the following permissions are required: + +### Create +
+opsworks-cm:CreateServer,
+opsworks-cm:DescribeServers,
+iam:PassRole
+ +### List +
+opsworks-cm:DescribeServers,
+opsworks-cm:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +server_name +FROM awscc.opsworkscm.servers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/account/index.md b/docs/awscc-docs/providers/awscc/organizations/account/index.md new file mode 100644 index 0000000000..4ce390a751 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/account/index.md @@ -0,0 +1,89 @@ +--- +title: account +hide_title: false +hide_table_of_contents: false +keywords: + - account + - 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 +--- +Gets an individual account resource + +## Overview + + + + + +
Nameaccount
TypeResource
Descriptionaccount
Idawscc.organizations.account
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
account_namestringThe friendly name of the member account.
emailstringThe email address of the owner to assign to the new member account.
role_namestringThe name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
parent_idsarrayList of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
tagsarrayA 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.
account_idstringIf the account was created successfully, the unique identifier (ID) of the new account.
arnstringThe Amazon Resource Name (ARN) of the account.
joined_methodstringThe method by which the account joined the organization.
joined_timestampstringThe date the account became a part of the organization.
statusstringThe status of the account in the organization.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account resource, the following permissions are required: + +### Read +
+organizations:DescribeAccount,
+organizations:ListParents,
+organizations:ListTagsForResource
+ +### Update +
+organizations:MoveAccount,
+organizations:TagResource,
+organizations:UntagResource,
+organizations:ListRoots,
+organizations:DescribeAccount,
+organizations:ListParents,
+organizations:ListTagsForResource
+ +### Delete +
+organizations:CloseAccount
+ + +## Example +```sql +SELECT +region, +account_name, +email, +role_name, +parent_ids, +tags, +account_id, +arn, +joined_method, +joined_timestamp, +status +FROM awscc.organizations.account +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/accounts/index.md b/docs/awscc-docs/providers/awscc/organizations/accounts/index.md new file mode 100644 index 0000000000..ff438d1342 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/accounts/index.md @@ -0,0 +1,64 @@ +--- +title: accounts +hide_title: false +hide_table_of_contents: false +keywords: + - accounts + - 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 +--- +Retrieves a list of accounts in a region + +## Overview + + + + + +
Nameaccounts
TypeResource
Descriptionaccounts
Idawscc.organizations.accounts
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringIf the account was created successfully, the unique identifier (ID) of the new account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Create +
+organizations:CreateAccount,
+organizations:DescribeCreateAccountStatus,
+organizations:MoveAccount,
+organizations:ListParents,
+organizations:TagResource,
+organizations:DescribeAccount,
+organizations:ListTagsForResource
+ +### List +
+organizations:ListAccounts
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.organizations.accounts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/index.md b/docs/awscc-docs/providers/awscc/organizations/index.md new file mode 100644 index 0000000000..cbab210deb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/index.md @@ -0,0 +1,47 @@ +--- +title: organizations +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The organizations service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+account
+accounts
+organization
+organizational_unit
+organizational_units +
+
+organizations
+policies
+policy
+resource_policies
+resource_policy +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/organizations/organization/index.md b/docs/awscc-docs/providers/awscc/organizations/organization/index.md new file mode 100644 index 0000000000..c4221a5901 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/organization/index.md @@ -0,0 +1,77 @@ +--- +title: organization +hide_title: false +hide_table_of_contents: false +keywords: + - organization + - 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 +--- +Gets an individual organization resource + +## Overview + + + + + +
Nameorganization
TypeResource
Descriptionorganization
Idawscc.organizations.organization
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) of an organization.
arnstringThe Amazon Resource Name (ARN) of an organization.
feature_setstringSpecifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
management_account_arnstringThe Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
management_account_idstringThe unique identifier (ID) of the management account of an organization.
management_account_emailstringThe email address that is associated with the AWS account that is designated as the management account for the organization.
root_idstringThe unique identifier (ID) for the root.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organization resource, the following permissions are required: + +### Read +
+organizations:DescribeOrganization,
+organizations:ListRoots
+ +### Delete +
+organizations:DeleteOrganization,
+organizations:DescribeOrganization
+ +### Update +
+
+ + +## Example +```sql +SELECT +region, +id, +arn, +feature_set, +management_account_arn, +management_account_id, +management_account_email, +root_id +FROM awscc.organizations.organization +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md b/docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md new file mode 100644 index 0000000000..c570c652d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md @@ -0,0 +1,78 @@ +--- +title: organizational_unit +hide_title: false +hide_table_of_contents: false +keywords: + - organizational_unit + - 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 +--- +Gets an individual organizational_unit resource + +## Overview + + + + + +
Nameorganizational_unit
TypeResource
Descriptionorganizational_unit
Idawscc.organizations.organizational_unit
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of this OU.
idstringThe unique identifier (ID) associated with this OU.
namestringThe friendly name of this OU.
parent_idstringThe unique identifier (ID) of the parent root or OU that you want to create the new OU in.
tagsarrayA list of tags that you want to attach to the newly created OU.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organizational_unit resource, the following permissions are required: + +### Read +
+organizations:DescribeOrganizationalUnit,
+organizations:ListParents,
+organizations:ListTagsForResource
+ +### Update +
+organizations:DescribeOrganizationalUnit,
+organizations:ListParents,
+organizations:ListTagsForResource,
+organizations:TagResource,
+organizations:UntagResource,
+organizations:UpdateOrganizationalUnit
+ +### Delete +
+organizations:DeleteOrganizationalUnit
+ + +## Example +```sql +SELECT +region, +arn, +id, +name, +parent_id, +tags +FROM awscc.organizations.organizational_unit +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md b/docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md new file mode 100644 index 0000000000..d44b06c304 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md @@ -0,0 +1,62 @@ +--- +title: organizational_units +hide_title: false +hide_table_of_contents: false +keywords: + - organizational_units + - 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 +--- +Retrieves a list of organizational_units in a region + +## Overview + + + + + +
Nameorganizational_units
TypeResource
Descriptionorganizational_units
Idawscc.organizations.organizational_units
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this OU.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organizational_units resource, the following permissions are required: + +### Create +
+organizations:CreateOrganizationalUnit,
+organizations:DescribeOrganizationalUnit,
+organizations:ListParents,
+organizations:ListTagsForResource,
+organizations:TagResource
+ +### List +
+organizations:ListOrganizationalUnitsForParent
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.organizations.organizational_units +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/organizations/index.md b/docs/awscc-docs/providers/awscc/organizations/organizations/index.md new file mode 100644 index 0000000000..67134cdb4c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/organizations/index.md @@ -0,0 +1,61 @@ +--- +title: organizations +hide_title: false +hide_table_of_contents: false +keywords: + - organizations + - 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 +--- +Retrieves a list of organizations in a region + +## Overview + + + + + +
Nameorganizations
TypeResource
Descriptionorganizations
Idawscc.organizations.organizations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) of an organization.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the organizations resource, the following permissions are required: + +### Create +
+organizations:CreateOrganization,
+organizations:DescribeOrganization,
+iam:CreateServiceLinkedRole,
+organizations:ListRoots
+ +### List +
+organizations:DescribeOrganization
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.organizations.organizations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/policies/index.md b/docs/awscc-docs/providers/awscc/organizations/policies/index.md new file mode 100644 index 0000000000..8516501598 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/policies/index.md @@ -0,0 +1,63 @@ +--- +title: policies +hide_title: false +hide_table_of_contents: false +keywords: + - policies + - 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 +--- +Retrieves a list of policies in a region + +## Overview + + + + + +
Namepolicies
TypeResource
Descriptionpolicies
Idawscc.organizations.policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId of the Policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +
+organizations:CreatePolicy,
+organizations:DescribePolicy,
+organizations:AttachPolicy,
+organizations:ListTagsForResource,
+organizations:ListTargetsForPolicy,
+organizations:TagResource
+ +### List +
+organizations:ListPolicies
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.organizations.policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/policy/index.md b/docs/awscc-docs/providers/awscc/organizations/policy/index.md new file mode 100644 index 0000000000..5c37b4e39c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/policy/index.md @@ -0,0 +1,89 @@ +--- +title: policy +hide_title: false +hide_table_of_contents: false +keywords: + - policy + - 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 +--- +Gets an individual policy resource + +## Overview + + + + + +
Namepolicy
TypeResource
Descriptionpolicy
Idawscc.organizations.policy
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the Policy
typestringThe type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
contentobjectThe 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.
descriptionstringHuman readable description of the policy
target_idsarrayList of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
tagsarrayA 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.
idstringId of the Policy
arnstringARN of the Policy
aws_managedbooleanA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Read +
+organizations:DescribePolicy,
+organizations:ListTargetsForPolicy,
+organizations:ListTagsForResource
+ +### Update +
+organizations:AttachPolicy,
+organizations:DetachPolicy,
+organizations:UpdatePolicy,
+organizations:ListTagsForResource,
+organizations:ListTargetsForPolicy,
+organizations:TagResource,
+organizations:UntagResource,
+organizations:DescribePolicy
+ +### Delete +
+organizations:DetachPolicy,
+organizations:DeletePolicy
+ + +## Example +```sql +SELECT +region, +name, +type, +content, +description, +target_ids, +tags, +id, +arn, +aws_managed +FROM awscc.organizations.policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md b/docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md new file mode 100644 index 0000000000..0467292350 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md @@ -0,0 +1,61 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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 +--- +Retrieves a list of resource_policies in a region + +## Overview + + + + + +
Nameresource_policies
TypeResource
Descriptionresource_policies
Idawscc.organizations.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this resource policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +
+organizations:PutResourcePolicy,
+organizations:DescribeResourcePolicy,
+organizations:ListTagsForResource,
+organizations:TagResource
+ +### List +
+organizations:DescribeResourcePolicy
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.organizations.resource_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md b/docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md new file mode 100644 index 0000000000..9b5354ebdc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md @@ -0,0 +1,74 @@ +--- +title: resource_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy + - 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 +--- +Gets an individual resource_policy resource + +## Overview + + + + + +
Nameresource_policy
TypeResource
Descriptionresource_policy
Idawscc.organizations.resource_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this resource policy.
arnstringThe Amazon Resource Name (ARN) of the resource policy.
contentobjectThe 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.
tagsarrayA list of tags that you want to attach to the resource policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +
+organizations:DescribeResourcePolicy,
+organizations:ListTagsForResource
+ +### Update +
+organizations:DescribeResourcePolicy,
+organizations:PutResourcePolicy,
+organizations:ListTagsForResource,
+organizations:TagResource,
+organizations:UntagResource
+ +### Delete +
+organizations:DeleteResourcePolicy
+ + +## Example +```sql +SELECT +region, +id, +arn, +content, +tags +FROM awscc.organizations.resource_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/osis/index.md b/docs/awscc-docs/providers/awscc/osis/index.md new file mode 100644 index 0000000000..2fba1eff0e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/osis/index.md @@ -0,0 +1,39 @@ +--- +title: osis +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The osis service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+pipeline +
+
+pipelines +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/osis/pipeline/index.md b/docs/awscc-docs/providers/awscc/osis/pipeline/index.md new file mode 100644 index 0000000000..3312c29f72 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/osis/pipeline/index.md @@ -0,0 +1,99 @@ +--- +title: pipeline +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline + - 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 +--- +Gets an individual pipeline resource + +## Overview + + + + + +
Namepipeline
TypeResource
Descriptionpipeline
Idawscc.osis.pipeline
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
buffer_optionsobject
encryption_at_rest_optionsobject
log_publishing_optionsobject
max_unitsintegerThe maximum pipeline capacity, in Ingestion Compute Units (ICUs).
min_unitsintegerThe minimum pipeline capacity, in Ingestion Compute Units (ICUs).
pipeline_configuration_bodystringThe Data Prepper pipeline configuration in YAML format.
pipeline_namestringName of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
tagsarrayAn array of key-value pairs to apply to this resource.
vpc_optionsobject
vpc_endpointsarrayThe VPC interface endpoints that have access to the pipeline.
pipeline_arnstringThe Amazon Resource Name (ARN) of the pipeline.
ingest_endpoint_urlsarrayA list of endpoints that can be used for ingesting data into a pipeline
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +
+osis:GetPipeline,
+osis:ListTagsForResource
+ +### Update +
+osis:UpdatePipeline,
+osis:GetPipeline,
+osis:ListTagsForResource,
+osis:TagResource,
+osis:UntagResource,
+iam:PassRole,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:ListLogDeliveries,
+kms:DescribeKey
+ +### Delete +
+osis:DeletePipeline,
+osis:GetPipeline,
+logs:GetLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries
+ + +## Example +```sql +SELECT +region, +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 awscc.osis.pipeline +WHERE region = 'us-east-1' +AND data__Identifier = '<PipelineArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/osis/pipelines/index.md b/docs/awscc-docs/providers/awscc/osis/pipelines/index.md new file mode 100644 index 0000000000..61964423cc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/osis/pipelines/index.md @@ -0,0 +1,65 @@ +--- +title: pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines + - 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 +--- +Retrieves a list of pipelines in a region + +## Overview + + + + + +
Namepipelines
TypeResource
Descriptionpipelines
Idawscc.osis.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_arnstringThe Amazon Resource Name (ARN) of the pipeline.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +
+osis:CreatePipeline,
+osis:GetPipeline,
+osis:TagResource,
+osis:ListTagsForResource,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+logs:CreateLogDelivery,
+kms:DescribeKey
+ +### List +
+osis:ListPipelines
+ + +## Example +```sql +SELECT +region, +pipeline_arn +FROM awscc.osis.pipelines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/panorama/application_instance/index.md b/docs/awscc-docs/providers/awscc/panorama/application_instance/index.md new file mode 100644 index 0000000000..8b4c33e83d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/panorama/application_instance/index.md @@ -0,0 +1,113 @@ +--- +title: application_instance +hide_title: false +hide_table_of_contents: false +keywords: + - application_instance + - 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 +--- +Gets an individual application_instance resource + +## Overview + + + + + +
Nameapplication_instance
TypeResource
Descriptionapplication_instance
Idawscc.panorama.application_instance
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
default_runtime_context_device_namestring
statusstring
default_runtime_context_devicestring
descriptionstring
application_instance_id_to_replacestring
created_timeinteger
health_statusstring
manifest_overrides_payloadobject
last_updated_timeinteger
runtime_role_arnstring
namestring
application_instance_idstring
status_descriptionstring
manifest_payloadobject
arnstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_instance resource, the following permissions are required: + +### Read +
+panorama:DescribeApplicationInstance,
+panorama:DescribeApplicationInstanceDetails,
+panorama:ListTagsForResource,
+s3:ListObjects,
+s3:GetObject,
+s3:GetObjectVersion
+ +### Update +
+panorama:ListTagsForResource,
+panorama:TagResource,
+panorama:UntagResource,
+panorama:DescribeApplicationInstance,
+panorama:DescribeApplicationInstanceDetails,
+s3:ListObjects,
+s3:GetObject,
+s3:GetObjectVersion
+ +### Delete +
+panorama:RemoveApplicationInstance,
+panorama:DescribeApplicationInstance,
+panorama:DescribeApplicationInstanceDetails,
+s3:DeleteObject,
+s3:DeleteObjectVersion,
+s3:DeleteObjectVersionTagging,
+s3:ListObjects,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```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, +tags +FROM awscc.panorama.application_instance +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationInstanceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/panorama/application_instances/index.md b/docs/awscc-docs/providers/awscc/panorama/application_instances/index.md new file mode 100644 index 0000000000..d1a341320a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/panorama/application_instances/index.md @@ -0,0 +1,70 @@ +--- +title: application_instances +hide_title: false +hide_table_of_contents: false +keywords: + - application_instances + - 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 +--- +Retrieves a list of application_instances in a region + +## Overview + + + + + +
Nameapplication_instances
TypeResource
Descriptionapplication_instances
Idawscc.panorama.application_instances
+ +## Fields + + + + + +
NameDatatypeDescription
application_instance_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application_instances resource, the following permissions are required: + +### Create +
+panorama:CreateApplicationInstance,
+panorama:ListTagsForResource,
+panorama:TagResource,
+panorama:DescribeApplicationInstance,
+panorama:DescribeApplicationInstanceDetails,
+iam:PassRole,
+s3:ListBucket,
+s3:PutObject,
+s3:GetObject,
+s3:GetObjectVersion
+ +### List +
+panorama:ListApplicationInstances,
+s3:ListBucket,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```sql +SELECT +region, +application_instance_id +FROM awscc.panorama.application_instances +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/panorama/index.md b/docs/awscc-docs/providers/awscc/panorama/index.md new file mode 100644 index 0000000000..7cb7959214 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/panorama/index.md @@ -0,0 +1,43 @@ +--- +title: panorama +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The panorama service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+application_instance
+application_instances
+package +
+
+package_version
+package_versions
+packages +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/panorama/package/index.md b/docs/awscc-docs/providers/awscc/panorama/package/index.md new file mode 100644 index 0000000000..750ee931b4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/panorama/package/index.md @@ -0,0 +1,93 @@ +--- +title: package +hide_title: false +hide_table_of_contents: false +keywords: + - package + - 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 +--- +Gets an individual package resource + +## Overview + + + + + +
Namepackage
TypeResource
Descriptionpackage
Idawscc.panorama.package
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
package_namestring
package_idstring
arnstring
storage_locationobject
created_timeinteger
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the package resource, the following permissions are required: + +### Read +
+panorama:DescribePackage,
+panorama:ListTagsForResource,
+s3:ListBucket,
+s3:GetObject,
+s3:GetObjectVersion
+ +### Update +
+panorama:DescribePackage,
+panorama:ListTagsForResource,
+panorama:TagResource,
+panorama:UntagResource,
+s3:PutObject,
+s3:ListBucket,
+s3:GetObject,
+s3:GetObjectVersion
+ +### Delete +
+panorama:DeletePackage,
+panorama:DescribePackage,
+s3:DeleteObject,
+s3:DeleteObjectVersion,
+s3:DeleteObjectVersionTagging,
+s3:ListObjects,
+s3:ListObjectsV2,
+s3:ListBucket,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```sql +SELECT +region, +package_name, +package_id, +arn, +storage_location, +created_time, +tags +FROM awscc.panorama.package +WHERE region = 'us-east-1' +AND data__Identifier = '<PackageId>' +``` diff --git a/docs/awscc-docs/providers/awscc/panorama/package_version/index.md b/docs/awscc-docs/providers/awscc/panorama/package_version/index.md new file mode 100644 index 0000000000..fb93a95598 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/panorama/package_version/index.md @@ -0,0 +1,102 @@ +--- +title: package_version +hide_title: false +hide_table_of_contents: false +keywords: + - package_version + - 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 +--- +Gets an individual package_version resource + +## Overview + + + + + +
Namepackage_version
TypeResource
Descriptionpackage_version
Idawscc.panorama.package_version
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
owner_accountstring
package_idstring
package_arnstring
package_versionstring
patch_versionstring
mark_latestboolean
is_latest_patchboolean
package_namestring
statusstring
status_descriptionstring
registered_timeinteger
updated_latest_patch_versionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the package_version resource, the following permissions are required: + +### Read +
+panorama:DescribePackageVersion,
+s3:ListBucket,
+s3:GetObject,
+s3:GetObjectVersion
+ +### Update +
+panorama:DescribePackageVersion,
+panorama:RegisterPackageVersion,
+s3:ListBucket,
+s3:PutObject,
+s3:GetObject,
+s3:GetObjectVersion
+ +### Delete +
+panorama:DeregisterPackageVersion,
+panorama:DescribePackageVersion,
+s3:DeleteObject,
+s3:DeleteObjectVersion,
+s3:DeleteObjectVersionTagging,
+s3:ListBucket,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```sql +SELECT +region, +owner_account, +package_id, +package_arn, +package_version, +patch_version, +mark_latest, +is_latest_patch, +package_name, +status, +status_description, +registered_time, +updated_latest_patch_version +FROM awscc.panorama.package_version +WHERE region = 'us-east-1' +AND data__Identifier = '<PackageId>' +AND data__Identifier = '<PackageVersion>' +AND data__Identifier = '<PatchVersion>' +``` diff --git a/docs/awscc-docs/providers/awscc/panorama/package_versions/index.md b/docs/awscc-docs/providers/awscc/panorama/package_versions/index.md new file mode 100644 index 0000000000..cf8c765a3e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/panorama/package_versions/index.md @@ -0,0 +1,63 @@ +--- +title: package_versions +hide_title: false +hide_table_of_contents: false +keywords: + - package_versions + - 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 +--- +Retrieves a list of package_versions in a region + +## Overview + + + + + +
Namepackage_versions
TypeResource
Descriptionpackage_versions
Idawscc.panorama.package_versions
+ +## Fields + + + + + + + +
NameDatatypeDescription
package_idundefined
package_versionundefined
patch_versionundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the package_versions resource, the following permissions are required: + +### Create +
+panorama:RegisterPackageVersion,
+panorama:DescribePackageVersion,
+s3:ListBucket,
+s3:PutObject,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```sql +SELECT +region, +package_id, +package_version, +patch_version +FROM awscc.panorama.package_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/panorama/packages/index.md b/docs/awscc-docs/providers/awscc/panorama/packages/index.md new file mode 100644 index 0000000000..a0753d6684 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/panorama/packages/index.md @@ -0,0 +1,68 @@ +--- +title: packages +hide_title: false +hide_table_of_contents: false +keywords: + - packages + - 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 +--- +Retrieves a list of packages in a region + +## Overview + + + + + +
Namepackages
TypeResource
Descriptionpackages
Idawscc.panorama.packages
+ +## Fields + + + + + +
NameDatatypeDescription
package_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the packages resource, the following permissions are required: + +### Create +
+panorama:CreatePackage,
+panorama:ListTagsForResource,
+panorama:TagResource,
+panorama:DescribePackage,
+s3:ListBucket,
+s3:PutObject,
+s3:GetObject,
+s3:GetObjectVersion
+ +### List +
+panorama:ListPackages,
+s3:ListBucket,
+s3:GetObject,
+s3:GetObjectVersion
+ + +## Example +```sql +SELECT +region, +package_id +FROM awscc.panorama.packages +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md new file mode 100644 index 0000000000..e2f4173351 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md @@ -0,0 +1,77 @@ +--- +title: connector +hide_title: false +hide_table_of_contents: false +keywords: + - connector + - 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 +--- +Gets an individual connector resource + +## Overview + + + + + +
Nameconnector
TypeResource
Descriptionconnector
Idawscc.pcaconnectorad.connector
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
certificate_authority_arnstring
connector_arnstring
directory_idstring
tagsobject
vpc_informationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +
+pca-connector-ad:ListTagsForResource,
+pca-connector-ad:GetConnector
+ +### Delete +
+pca-connector-ad:GetConnector,
+pca-connector-ad:DeleteConnector,
+ec2:DeleteVpcEndpoints,
+ec2:DescribeVpcEndpoints
+ +### Update +
+pca-connector-ad:ListTagsForResource,
+pca-connector-ad:TagResource,
+pca-connector-ad:UntagResource
+ + +## Example +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +directory_id, +tags, +vpc_information +FROM awscc.pcaconnectorad.connector +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectorArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md new file mode 100644 index 0000000000..0315a16126 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md @@ -0,0 +1,67 @@ +--- +title: connectors +hide_title: false +hide_table_of_contents: false +keywords: + - connectors + - 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 +--- +Retrieves a list of connectors in a region + +## Overview + + + + + +
Nameconnectors
TypeResource
Descriptionconnectors
Idawscc.pcaconnectorad.connectors
+ +## Fields + + + + + +
NameDatatypeDescription
connector_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +
+acm-pca:DescribeCertificateAuthority,
+acm-pca:GetCertificateAuthorityCertificate,
+acm-pca:GetCertificate,
+acm-pca:IssueCertificate,
+ds:DescribeDirectories,
+ec2:CreateTags,
+ec2:CreateVpcEndpoint,
+ec2:DescribeVpcEndpoints,
+pca-connector-ad:CreateConnector,
+pca-connector-ad:GetConnector
+ +### List +
+pca-connector-ad:ListConnectors
+ + +## Example +```sql +SELECT +region, +connector_arn +FROM awscc.pcaconnectorad.connectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md new file mode 100644 index 0000000000..f1408cc40e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md @@ -0,0 +1,74 @@ +--- +title: directory_registration +hide_title: false +hide_table_of_contents: false +keywords: + - directory_registration + - 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 +--- +Gets an individual directory_registration resource + +## Overview + + + + + +
Namedirectory_registration
TypeResource
Descriptiondirectory_registration
Idawscc.pcaconnectorad.directory_registration
+ +## Fields + + + + + + + +
NameDatatypeDescription
directory_idstring
directory_registration_arnstring
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the directory_registration resource, the following permissions are required: + +### Read +
+pca-connector-ad:ListTagsForResource,
+pca-connector-ad:GetDirectoryRegistration
+ +### Delete +
+pca-connector-ad:GetDirectoryRegistration,
+pca-connector-ad:DeleteDirectoryRegistration,
+ds:DescribeDirectories,
+ds:UnauthorizeApplication,
+ds:UpdateAuthorizedApplication
+ +### Update +
+pca-connector-ad:ListTagsForResource,
+pca-connector-ad:TagResource,
+pca-connector-ad:UntagResource
+ + +## Example +```sql +SELECT +region, +directory_id, +directory_registration_arn, +tags +FROM awscc.pcaconnectorad.directory_registration +WHERE region = 'us-east-1' +AND data__Identifier = '<DirectoryRegistrationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md new file mode 100644 index 0000000000..bd64c1c39e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md @@ -0,0 +1,61 @@ +--- +title: directory_registrations +hide_title: false +hide_table_of_contents: false +keywords: + - directory_registrations + - 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 +--- +Retrieves a list of directory_registrations in a region + +## Overview + + + + + +
Namedirectory_registrations
TypeResource
Descriptiondirectory_registrations
Idawscc.pcaconnectorad.directory_registrations
+ +## Fields + + + + + +
NameDatatypeDescription
directory_registration_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the directory_registrations resource, the following permissions are required: + +### Create +
+pca-connector-ad:GetDirectoryRegistration,
+pca-connector-ad:CreateDirectoryRegistration,
+ds:AuthorizeApplication,
+ds:DescribeDirectories
+ +### List +
+pca-connector-ad:ListDirectoryRegistrations
+ + +## Example +```sql +SELECT +region, +directory_registration_arn +FROM awscc.pcaconnectorad.directory_registrations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/index.md new file mode 100644 index 0000000000..6028d45e51 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/index.md @@ -0,0 +1,47 @@ +--- +title: pcaconnectorad +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The pcaconnectorad service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+connector
+connectors
+directory_registration
+directory_registrations
+service_principal_name +
+
+service_principal_names
+template
+template_group_access_control_entries
+template_group_access_control_entry
+templates +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_name/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_name/index.md new file mode 100644 index 0000000000..b7019fd276 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_name/index.md @@ -0,0 +1,64 @@ +--- +title: service_principal_name +hide_title: false +hide_table_of_contents: false +keywords: + - service_principal_name + - 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 +--- +Gets an individual service_principal_name resource + +## Overview + + + + + +
Nameservice_principal_name
TypeResource
Descriptionservice_principal_name
Idawscc.pcaconnectorad.service_principal_name
+ +## Fields + + + + + + +
NameDatatypeDescription
connector_arnstring
directory_registration_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_principal_name resource, the following permissions are required: + +### Read +
+pca-connector-ad:GetServicePrincipalName
+ +### Delete +
+ds:UpdateAuthorizedApplication,
+pca-connector-ad:GetServicePrincipalName,
+pca-connector-ad:DeleteServicePrincipalName
+ + +## Example +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM awscc.pcaconnectorad.service_principal_name +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectorArn>' +AND data__Identifier = '<DirectoryRegistrationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_names/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_names/index.md new file mode 100644 index 0000000000..44c099b664 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_names/index.md @@ -0,0 +1,62 @@ +--- +title: service_principal_names +hide_title: false +hide_table_of_contents: false +keywords: + - service_principal_names + - 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 +--- +Retrieves a list of service_principal_names in a region + +## Overview + + + + + +
Nameservice_principal_names
TypeResource
Descriptionservice_principal_names
Idawscc.pcaconnectorad.service_principal_names
+ +## Fields + + + + + + +
NameDatatypeDescription
connector_arnstring
directory_registration_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_principal_names resource, the following permissions are required: + +### Create +
+ds:UpdateAuthorizedApplication,
+pca-connector-ad:GetServicePrincipalName,
+pca-connector-ad:CreateServicePrincipalName
+ +### List +
+pca-connector-ad:ListServicePrincipalNames
+ + +## Example +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM awscc.pcaconnectorad.service_principal_names +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md new file mode 100644 index 0000000000..64690a8c35 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md @@ -0,0 +1,78 @@ +--- +title: template +hide_title: false +hide_table_of_contents: false +keywords: + - template + - 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 +--- +Gets an individual template resource + +## Overview + + + + + +
Nametemplate
TypeResource
Descriptiontemplate
Idawscc.pcaconnectorad.template
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
connector_arnstring
definitionundefined
namestring
reenroll_all_certificate_holdersboolean
tagsobject
template_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the template resource, the following permissions are required: + +### Read +
+pca-connector-ad:GetTemplate,
+pca-connector-ad:ListTagsForResource
+ +### Update +
+pca-connector-ad:ListTagsForResource,
+pca-connector-ad:TagResource,
+pca-connector-ad:UntagResource,
+pca-connector-ad:UpdateTemplate
+ +### Delete +
+pca-connector-ad:GetTemplate,
+pca-connector-ad:DeleteTemplate
+ + +## Example +```sql +SELECT +region, +connector_arn, +definition, +name, +reenroll_all_certificate_holders, +tags, +template_arn +FROM awscc.pcaconnectorad.template +WHERE region = 'us-east-1' +AND data__Identifier = '<TemplateArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entries/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entries/index.md new file mode 100644 index 0000000000..1a4c395527 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entries/index.md @@ -0,0 +1,60 @@ +--- +title: template_group_access_control_entries +hide_title: false +hide_table_of_contents: false +keywords: + - template_group_access_control_entries + - 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 +--- +Retrieves a list of template_group_access_control_entries in a region + +## Overview + + + + + +
Nametemplate_group_access_control_entries
TypeResource
Descriptiontemplate_group_access_control_entries
Idawscc.pcaconnectorad.template_group_access_control_entries
+ +## Fields + + + + + + +
NameDatatypeDescription
group_security_identifierstring
template_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the template_group_access_control_entries resource, the following permissions are required: + +### Create +
+pca-connector-ad:CreateTemplateGroupAccessControlEntry
+ +### List +
+pca-connector-ad:ListTemplateGroupAccessControlEntries
+ + +## Example +```sql +SELECT +region, +group_security_identifier, +template_arn +FROM awscc.pcaconnectorad.template_group_access_control_entries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entry/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entry/index.md new file mode 100644 index 0000000000..ed744a667b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entry/index.md @@ -0,0 +1,71 @@ +--- +title: template_group_access_control_entry +hide_title: false +hide_table_of_contents: false +keywords: + - template_group_access_control_entry + - 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 +--- +Gets an individual template_group_access_control_entry resource + +## Overview + + + + + +
Nametemplate_group_access_control_entry
TypeResource
Descriptiontemplate_group_access_control_entry
Idawscc.pcaconnectorad.template_group_access_control_entry
+ +## Fields + + + + + + + + +
NameDatatypeDescription
access_rightsobject
group_display_namestring
group_security_identifierstring
template_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the template_group_access_control_entry resource, the following permissions are required: + +### Read +
+pca-connector-ad:GetTemplateGroupAccessControlEntry
+ +### Update +
+pca-connector-ad:UpdateTemplateGroupAccessControlEntry
+ +### Delete +
+pca-connector-ad:DeleteTemplateGroupAccessControlEntry,
+pca-connector-ad:GetTemplateGroupAccessControlEntry
+ + +## Example +```sql +SELECT +region, +access_rights, +group_display_name, +group_security_identifier, +template_arn +FROM awscc.pcaconnectorad.template_group_access_control_entry +WHERE region = 'us-east-1' +AND data__Identifier = '<GroupSecurityIdentifier>' +AND data__Identifier = '<TemplateArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md new file mode 100644 index 0000000000..268c43c217 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md @@ -0,0 +1,58 @@ +--- +title: templates +hide_title: false +hide_table_of_contents: false +keywords: + - templates + - 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 +--- +Retrieves a list of templates in a region + +## Overview + + + + + +
Nametemplates
TypeResource
Descriptiontemplates
Idawscc.pcaconnectorad.templates
+ +## Fields + + + + + +
NameDatatypeDescription
template_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Create +
+pca-connector-ad:CreateTemplate
+ +### List +
+pca-connector-ad:ListTemplates
+ + +## Example +```sql +SELECT +region, +template_arn +FROM awscc.pcaconnectorad.templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/dataset/index.md b/docs/awscc-docs/providers/awscc/personalize/dataset/index.md new file mode 100644 index 0000000000..aacf971e07 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/dataset/index.md @@ -0,0 +1,77 @@ +--- +title: dataset +hide_title: false +hide_table_of_contents: false +keywords: + - dataset + - 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 +--- +Gets an individual dataset resource + +## Overview + + + + + +
Namedataset
TypeResource
Descriptiondataset
Idawscc.personalize.dataset
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringThe name for the dataset
dataset_arnstringThe ARN of the dataset
dataset_typestringThe type of dataset
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group to add the dataset to
schema_arnstringThe ARN of the schema to associate with the dataset. The schema defines the dataset fields.
dataset_import_jobobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +
+personalize:DescribeDataset
+ +### Update +
+personalize:DescribeDataset,
+personalize:CreateDatasetImportJob,
+personalize:DescribeDatasetImportJob,
+iam:PassRole
+ +### Delete +
+personalize:DeleteDataset,
+personalize:DescribeDataset
+ + +## Example +```sql +SELECT +region, +name, +dataset_arn, +dataset_type, +dataset_group_arn, +schema_arn, +dataset_import_job +FROM awscc.personalize.dataset +WHERE region = 'us-east-1' +AND data__Identifier = '<DatasetArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md b/docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md new file mode 100644 index 0000000000..df4d7d591a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md @@ -0,0 +1,68 @@ +--- +title: dataset_group +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_group + - 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 +--- +Gets an individual dataset_group resource + +## Overview + + + + + +
Namedataset_group
TypeResource
Descriptiondataset_group
Idawscc.personalize.dataset_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group.
namestringThe name for the new dataset group.
kms_key_arnstringThe Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets.
role_arnstringThe 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.
domainstringThe domain of a Domain dataset group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset_group resource, the following permissions are required: + +### Read +
+personalize:DescribeDatasetGroup
+ +### Delete +
+personalize:DescribeDatasetGroup,
+personalize:DeleteDatasetGroup
+ + +## Example +```sql +SELECT +region, +dataset_group_arn, +name, +kms_key_arn, +role_arn, +domain +FROM awscc.personalize.dataset_group +WHERE region = 'us-east-1' +AND data__Identifier = '<DatasetGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md b/docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md new file mode 100644 index 0000000000..38ad8f97f0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md @@ -0,0 +1,60 @@ +--- +title: dataset_groups +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_groups + - 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 +--- +Retrieves a list of dataset_groups in a region + +## Overview + + + + + +
Namedataset_groups
TypeResource
Descriptiondataset_groups
Idawscc.personalize.dataset_groups
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dataset_groups resource, the following permissions are required: + +### Create +
+personalize:CreateDatasetGroup,
+personalize:DescribeDatasetGroup,
+iam:PassRole
+ +### List +
+personalize:ListDatasetGroups
+ + +## Example +```sql +SELECT +region, +dataset_group_arn +FROM awscc.personalize.dataset_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/datasets/index.md b/docs/awscc-docs/providers/awscc/personalize/datasets/index.md new file mode 100644 index 0000000000..20204cfc5b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/datasets/index.md @@ -0,0 +1,62 @@ +--- +title: datasets +hide_title: false +hide_table_of_contents: false +keywords: + - datasets + - 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 +--- +Retrieves a list of datasets in a region + +## Overview + + + + + +
Namedatasets
TypeResource
Descriptiondatasets
Idawscc.personalize.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_arnstringThe ARN of the dataset
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +
+personalize:CreateDataset,
+personalize:DescribeDataset,
+personalize:CreateDatasetImportJob,
+personalize:DescribeDatasetImportJob,
+iam:PassRole
+ +### List +
+personalize:ListDatasets
+ + +## Example +```sql +SELECT +region, +dataset_arn +FROM awscc.personalize.datasets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/index.md b/docs/awscc-docs/providers/awscc/personalize/index.md new file mode 100644 index 0000000000..8df4cab633 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/index.md @@ -0,0 +1,45 @@ +--- +title: personalize +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The personalize service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+dataset
+dataset_group
+dataset_groups
+datasets +
+
+schema
+schemata
+solution
+solutions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/personalize/schema/index.md b/docs/awscc-docs/providers/awscc/personalize/schema/index.md new file mode 100644 index 0000000000..e367ca5579 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/schema/index.md @@ -0,0 +1,66 @@ +--- +title: schema +hide_title: false +hide_table_of_contents: false +keywords: + - schema + - 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 +--- +Gets an individual schema resource + +## Overview + + + + + +
Nameschema
TypeResource
Descriptionschema
Idawscc.personalize.schema
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringName for the schema.
schema_arnstringArn for the schema.
schemastringA schema in Avro JSON format.
domainstringThe domain of a Domain dataset group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schema resource, the following permissions are required: + +### Read +
+personalize:DescribeSchema
+ +### Delete +
+personalize:DeleteSchema,
+personalize:DescribeSchema
+ + +## Example +```sql +SELECT +region, +name, +schema_arn, +schema, +domain +FROM awscc.personalize.schema +WHERE region = 'us-east-1' +AND data__Identifier = '<SchemaArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/schemata/index.md b/docs/awscc-docs/providers/awscc/personalize/schemata/index.md new file mode 100644 index 0000000000..8b4d709e8a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/schemata/index.md @@ -0,0 +1,59 @@ +--- +title: schemata +hide_title: false +hide_table_of_contents: false +keywords: + - schemata + - 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 +--- +Retrieves a list of schemata in a region + +## Overview + + + + + +
Nameschemata
TypeResource
Descriptionschemata
Idawscc.personalize.schemata
+ +## Fields + + + + + +
NameDatatypeDescription
schema_arnstringArn for the schema.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schemata resource, the following permissions are required: + +### Create +
+personalize:CreateSchema,
+personalize:DescribeSchema
+ +### List +
+personalize:ListSchemas
+ + +## Example +```sql +SELECT +region, +schema_arn +FROM awscc.personalize.schemata +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/solution/index.md b/docs/awscc-docs/providers/awscc/personalize/solution/index.md new file mode 100644 index 0000000000..28c9eb9bb8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/solution/index.md @@ -0,0 +1,74 @@ +--- +title: solution +hide_title: false +hide_table_of_contents: false +keywords: + - solution + - 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 +--- +Gets an individual solution resource + +## Overview + + + + + +
Namesolution
TypeResource
Descriptionsolution
Idawscc.personalize.solution
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name for the solution
solution_arnstring
event_typestringWhen 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.
dataset_group_arnstringThe ARN of the dataset group that provides the training data.
perform_auto_mlbooleanWhether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.
perform_hp_obooleanWhether 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.
recipe_arnstringThe ARN of the recipe to use for model training. Only specified when performAutoML is false.
solution_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the solution resource, the following permissions are required: + +### Read +
+personalize:DescribeSolution
+ +### Delete +
+personalize:DeleteSolution,
+personalize:DescribeSolution
+ + +## Example +```sql +SELECT +region, +name, +solution_arn, +event_type, +dataset_group_arn, +perform_auto_ml, +perform_hp_o, +recipe_arn, +solution_config +FROM awscc.personalize.solution +WHERE region = 'us-east-1' +AND data__Identifier = '<SolutionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/personalize/solutions/index.md b/docs/awscc-docs/providers/awscc/personalize/solutions/index.md new file mode 100644 index 0000000000..1756dab900 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/personalize/solutions/index.md @@ -0,0 +1,59 @@ +--- +title: solutions +hide_title: false +hide_table_of_contents: false +keywords: + - solutions + - 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 +--- +Retrieves a list of solutions in a region + +## Overview + + + + + +
Namesolutions
TypeResource
Descriptionsolutions
Idawscc.personalize.solutions
+ +## Fields + + + + + +
NameDatatypeDescription
solution_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the solutions resource, the following permissions are required: + +### Create +
+personalize:CreateSolution,
+personalize:DescribeSolution
+ +### List +
+personalize:ListSolutions
+ + +## Example +```sql +SELECT +region, +solution_arn +FROM awscc.personalize.solutions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/pinpoint/in_app_template/index.md b/docs/awscc-docs/providers/awscc/pinpoint/in_app_template/index.md new file mode 100644 index 0000000000..dd7514a3aa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pinpoint/in_app_template/index.md @@ -0,0 +1,78 @@ +--- +title: in_app_template +hide_title: false +hide_table_of_contents: false +keywords: + - in_app_template + - 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 +--- +Gets an individual in_app_template resource + +## Overview + + + + + +
Namein_app_template
TypeResource
Descriptionin_app_template
Idawscc.pinpoint.in_app_template
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
contentarray
custom_configobject
layoutstring
tagsobject
template_descriptionstring
template_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the in_app_template resource, the following permissions are required: + +### Delete +
+mobiletargeting:DeleteInAppTemplate,
+mobiletargeting:GetInAppTemplate
+ +### Read +
+mobiletargeting:GetInAppTemplate,
+mobiletargeting:ListTemplates
+ +### Update +
+mobiletargeting:UpdateInAppTemplate,
+mobiletargeting:GetInAppTemplate
+ + +## Example +```sql +SELECT +region, +arn, +content, +custom_config, +layout, +tags, +template_description, +template_name +FROM awscc.pinpoint.in_app_template +WHERE region = 'us-east-1' +AND data__Identifier = '<TemplateName>' +``` diff --git a/docs/awscc-docs/providers/awscc/pinpoint/in_app_templates/index.md b/docs/awscc-docs/providers/awscc/pinpoint/in_app_templates/index.md new file mode 100644 index 0000000000..948d686fef --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pinpoint/in_app_templates/index.md @@ -0,0 +1,61 @@ +--- +title: in_app_templates +hide_title: false +hide_table_of_contents: false +keywords: + - in_app_templates + - 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 +--- +Retrieves a list of in_app_templates in a region + +## Overview + + + + + +
Namein_app_templates
TypeResource
Descriptionin_app_templates
Idawscc.pinpoint.in_app_templates
+ +## Fields + + + + + +
NameDatatypeDescription
template_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the in_app_templates resource, the following permissions are required: + +### Create +
+mobiletargeting:CreateInAppTemplate,
+mobiletargeting:GetInAppTemplate,
+mobiletargeting:TagResource
+ +### List +
+mobiletargeting:GetInAppTemplate,
+mobiletargeting:ListTemplates
+ + +## Example +```sql +SELECT +region, +template_name +FROM awscc.pinpoint.in_app_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/pinpoint/index.md b/docs/awscc-docs/providers/awscc/pinpoint/index.md new file mode 100644 index 0000000000..e90b2b52ec --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pinpoint/index.md @@ -0,0 +1,39 @@ +--- +title: pinpoint +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The pinpoint service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+in_app_template +
+
+in_app_templates +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/pipes/index.md b/docs/awscc-docs/providers/awscc/pipes/index.md new file mode 100644 index 0000000000..39e4398cae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pipes/index.md @@ -0,0 +1,39 @@ +--- +title: pipes +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The pipes service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+pipe +
+
+pipes +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/pipes/pipe/index.md b/docs/awscc-docs/providers/awscc/pipes/pipe/index.md new file mode 100644 index 0000000000..387ccfc3a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pipes/pipe/index.md @@ -0,0 +1,117 @@ +--- +title: pipe +hide_title: false +hide_table_of_contents: false +keywords: + - pipe + - 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 +--- +Gets an individual pipe resource + +## Overview + + + + + +
Namepipe
TypeResource
Descriptionpipe
Idawscc.pipes.pipe
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
current_statestring
descriptionstring
desired_statestring
enrichmentstring
enrichment_parametersobject
last_modified_timestring
log_configurationobject
namestring
role_arnstring
sourcestring
source_parametersobject
state_reasonstring
tagsobject
targetstring
target_parametersobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipe resource, the following permissions are required: + +### Read +
+pipes:DescribePipe
+ +### Update +
+pipes:UpdatePipe,
+pipes:TagResource,
+pipes:UntagResource,
+pipes:DescribePipe,
+iam:PassRole,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+iam:CreateServiceLinkedRole,
+logs:CreateLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+firehose:TagDeliveryStream
+ +### Delete +
+pipes:DeletePipe,
+pipes:DescribePipe,
+logs:CreateLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries
+ + +## Example +```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, +tags, +target, +target_parameters +FROM awscc.pipes.pipe +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/pipes/pipes/index.md b/docs/awscc-docs/providers/awscc/pipes/pipes/index.md new file mode 100644 index 0000000000..e08a42fa55 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/pipes/pipes/index.md @@ -0,0 +1,71 @@ +--- +title: pipes +hide_title: false +hide_table_of_contents: false +keywords: + - pipes + - 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 +--- +Retrieves a list of pipes in a region + +## Overview + + + + + +
Namepipes
TypeResource
Descriptionpipes
Idawscc.pipes.pipes
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipes resource, the following permissions are required: + +### Create +
+pipes:CreatePipe,
+pipes:DescribePipe,
+pipes:TagResource,
+iam:PassRole,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+iam:CreateServiceLinkedRole,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:ListLogDeliveries,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+firehose:TagDeliveryStream
+ +### List +
+pipes:ListPipes
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.pipes.pipes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/proton/environment_account_connection/index.md b/docs/awscc-docs/providers/awscc/proton/environment_account_connection/index.md new file mode 100644 index 0000000000..f1f8f1b128 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/proton/environment_account_connection/index.md @@ -0,0 +1,94 @@ +--- +title: environment_account_connection +hide_title: false +hide_table_of_contents: false +keywords: + - environment_account_connection + - 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 +--- +Gets an individual environment_account_connection resource + +## Overview + + + + + +
Nameenvironment_account_connection
TypeResource
Descriptionenvironment_account_connection
Idawscc.proton.environment_account_connection
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the environment account connection.
codebuild_role_arnstringThe 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.
component_role_arnstringThe 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.
environment_account_idstringThe environment account that's connected to the environment account connection.
environment_namestringThe name of the AWS Proton environment that's created in the associated management account.
idstringThe ID of the environment account connection.
management_account_idstringThe 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.
role_arnstringThe 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.
statusstringThe status of the environment account connection.
tagsarray<p>An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_account_connection resource, the following permissions are required: + +### Read +
+proton:GetEnvironmentAccountConnection,
+proton:ListTagsForResource,
+iam:PassRole,
+proton:GetEnvironmentAccountConnection
+ +### Update +
+proton:CreateEnvironmentAccountConnection,
+proton:ListTagsForResource,
+proton:TagResource,
+proton:UntagResource,
+proton:UpdateEnvironmentAccountConnection,
+iam:PassRole,
+proton:GetEnvironmentAccountConnection
+ +### Delete +
+proton:DeleteEnvironmentAccountConnection,
+proton:UntagResource,
+iam:PassRole,
+proton:ListTagsForResource,
+proton:GetEnvironmentAccountConnection
+ + +## Example +```sql +SELECT +region, +arn, +codebuild_role_arn, +component_role_arn, +environment_account_id, +environment_name, +id, +management_account_id, +role_arn, +status, +tags +FROM awscc.proton.environment_account_connection +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/proton/environment_account_connections/index.md b/docs/awscc-docs/providers/awscc/proton/environment_account_connections/index.md new file mode 100644 index 0000000000..f7a7a901a9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/proton/environment_account_connections/index.md @@ -0,0 +1,62 @@ +--- +title: environment_account_connections +hide_title: false +hide_table_of_contents: false +keywords: + - environment_account_connections + - 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 +--- +Retrieves a list of environment_account_connections in a region + +## Overview + + + + + +
Nameenvironment_account_connections
TypeResource
Descriptionenvironment_account_connections
Idawscc.proton.environment_account_connections
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the environment account connection.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_account_connections resource, the following permissions are required: + +### Create +
+proton:CreateEnvironmentAccountConnection,
+proton:TagResource,
+iam:PassRole,
+proton:ListTagsForResource,
+proton:GetEnvironmentAccountConnection
+ +### List +
+proton:ListEnvironmentAccountConnections
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.proton.environment_account_connections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/proton/environment_template/index.md b/docs/awscc-docs/providers/awscc/proton/environment_template/index.md new file mode 100644 index 0000000000..6a26b565d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/proton/environment_template/index.md @@ -0,0 +1,85 @@ +--- +title: environment_template +hide_title: false +hide_table_of_contents: false +keywords: + - environment_template + - 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 +--- +Gets an individual environment_template resource + +## Overview + + + + + +
Nameenvironment_template
TypeResource
Descriptionenvironment_template
Idawscc.proton.environment_template
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the environment template.</p>
descriptionstring<p>A description of the environment template.</p>
display_namestring<p>The environment template name as displayed in the developer interface.</p>
encryption_keystring<p>A customer provided encryption key that Proton uses to encrypt data.</p>
namestring
provisioningstring
tagsarray<p>An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_template resource, the following permissions are required: + +### Read +
+proton:GetEnvironmentTemplate,
+proton:ListTagsForResource,
+kms:*
+ +### Update +
+proton:CreateEnvironmentTemplate,
+proton:ListTagsForResource,
+proton:TagResource,
+proton:UntagResource,
+proton:UpdateEnvironmentTemplate,
+proton:GetEnvironmentTemplate,
+kms:*
+ +### Delete +
+proton:DeleteEnvironmentTemplate,
+proton:GetEnvironmentTemplate,
+kms:*
+ + +## Example +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +provisioning, +tags +FROM awscc.proton.environment_template +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/proton/environment_templates/index.md b/docs/awscc-docs/providers/awscc/proton/environment_templates/index.md new file mode 100644 index 0000000000..65c34130e9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/proton/environment_templates/index.md @@ -0,0 +1,61 @@ +--- +title: environment_templates +hide_title: false +hide_table_of_contents: false +keywords: + - environment_templates + - 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 +--- +Retrieves a list of environment_templates in a region + +## Overview + + + + + +
Nameenvironment_templates
TypeResource
Descriptionenvironment_templates
Idawscc.proton.environment_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the environment template.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment_templates resource, the following permissions are required: + +### Create +
+proton:CreateEnvironmentTemplate,
+proton:TagResource,
+proton:GetEnvironmentTemplate,
+kms:*
+ +### List +
+proton:ListEnvironmentTemplates
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.proton.environment_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/proton/index.md b/docs/awscc-docs/providers/awscc/proton/index.md new file mode 100644 index 0000000000..aa09f31302 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/proton/index.md @@ -0,0 +1,43 @@ +--- +title: proton +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The proton service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+environment_account_connection
+environment_account_connections
+environment_template +
+
+environment_templates
+service_template
+service_templates +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/proton/service_template/index.md b/docs/awscc-docs/providers/awscc/proton/service_template/index.md new file mode 100644 index 0000000000..ef3256b42a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/proton/service_template/index.md @@ -0,0 +1,86 @@ +--- +title: service_template +hide_title: false +hide_table_of_contents: false +keywords: + - service_template + - 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 +--- +Gets an individual service_template resource + +## Overview + + + + + +
Nameservice_template
TypeResource
Descriptionservice_template
Idawscc.proton.service_template
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the service template.</p>
descriptionstring<p>A description of the service template.</p>
display_namestring<p>The name of the service template as displayed in the developer interface.</p>
encryption_keystring<p>A customer provided encryption key that's used to encrypt data.</p>
namestring
pipeline_provisioningstring
tagsarray<p>An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.</p><br/> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br/> <i>Proton User Guide</i>.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_template resource, the following permissions are required: + +### Read +
+proton:GetServiceTemplate,
+proton:ListTagsForResource,
+kms:*
+ +### Update +
+proton:GetServiceTemplate,
+proton:CreateServiceTemplate,
+proton:ListTagsForResource,
+proton:TagResource,
+proton:UntagResource,
+proton:UpdateServiceTemplate,
+kms:*
+ +### Delete +
+proton:DeleteServiceTemplate,
+proton:UntagResource,
+kms:*,
+proton:GetServiceTemplate
+ + +## Example +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +pipeline_provisioning, +tags +FROM awscc.proton.service_template +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/proton/service_templates/index.md b/docs/awscc-docs/providers/awscc/proton/service_templates/index.md new file mode 100644 index 0000000000..61ab98ba9d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/proton/service_templates/index.md @@ -0,0 +1,61 @@ +--- +title: service_templates +hide_title: false +hide_table_of_contents: false +keywords: + - service_templates + - 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 +--- +Retrieves a list of service_templates in a region + +## Overview + + + + + +
Nameservice_templates
TypeResource
Descriptionservice_templates
Idawscc.proton.service_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the service template.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_templates resource, the following permissions are required: + +### Create +
+proton:CreateServiceTemplate,
+proton:TagResource,
+kms:*,
+proton:GetServiceTemplate
+ +### List +
+proton:ListServiceTemplates
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.proton.service_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/qldb/index.md b/docs/awscc-docs/providers/awscc/qldb/index.md new file mode 100644 index 0000000000..ec8363bcd2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/qldb/index.md @@ -0,0 +1,39 @@ +--- +title: qldb +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The qldb service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+qldb_stream +
+
+streams +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/qldb/qldb_stream/index.md b/docs/awscc-docs/providers/awscc/qldb/qldb_stream/index.md new file mode 100644 index 0000000000..3cdbf448c0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/qldb/qldb_stream/index.md @@ -0,0 +1,84 @@ +--- +title: qldb_stream +hide_title: false +hide_table_of_contents: false +keywords: + - qldb_stream + - 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 +--- +Gets an individual qldb_stream resource + +## Overview + + + + + +
Nameqldb_stream
TypeResource
Descriptionqldb_stream
Idawscc.qldb.qldb_stream
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
ledger_namestring
stream_namestring
role_arnstring
inclusive_start_timestring
exclusive_end_timestring
kinesis_configurationobject
tagsarrayAn array of key-value pairs to apply to this resource.
arnstring
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the qldb_stream resource, the following permissions are required: + +### Delete +
+qldb:CancelJournalKinesisStream,
+qldb:DescribeJournalKinesisStream
+ +### Read +
+qldb:DescribeJournalKinesisStream,
+qldb:ListTagsForResource
+ +### Update +
+qldb:DescribeJournalKinesisStream,
+qldb:UntagResource,
+qldb:TagResource
+ + +## Example +```sql +SELECT +region, +ledger_name, +stream_name, +role_arn, +inclusive_start_time, +exclusive_end_time, +kinesis_configuration, +tags, +arn, +id +FROM awscc.qldb.qldb_stream +WHERE region = 'us-east-1' +AND data__Identifier = '<LedgerName>' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/qldb/streams/index.md b/docs/awscc-docs/providers/awscc/qldb/streams/index.md new file mode 100644 index 0000000000..d2a23407f9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/qldb/streams/index.md @@ -0,0 +1,62 @@ +--- +title: streams +hide_title: false +hide_table_of_contents: false +keywords: + - streams + - 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 +--- +Retrieves a list of streams in a region + +## Overview + + + + + +
Namestreams
TypeResource
Descriptionstreams
Idawscc.qldb.streams
+ +## Fields + + + + + + +
NameDatatypeDescription
ledger_namestring
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +
+iam:PassRole,
+qldb:StreamJournalToKinesis,
+qldb:DescribeJournalKinesisStream
+ +### List +
+qldb:listJournalKinesisStreamsForLedger
+ + +## Example +```sql +SELECT +region, +ledger_name, +id +FROM awscc.qldb.streams +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/analyses/index.md b/docs/awscc-docs/providers/awscc/quicksight/analyses/index.md new file mode 100644 index 0000000000..4d33869894 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/analyses/index.md @@ -0,0 +1,68 @@ +--- +title: analyses +hide_title: false +hide_table_of_contents: false +keywords: + - analyses + - 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 +--- +Retrieves a list of analyses in a region + +## Overview + + + + + +
Nameanalyses
TypeResource
Descriptionanalyses
Idawscc.quicksight.analyses
+ +## Fields + + + + + + +
NameDatatypeDescription
analysis_idstring
aws_account_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the analyses resource, the following permissions are required: + +### Create +
+quicksight:DescribeAnalysis,
+quicksight:DescribeAnalysisPermissions,
+quicksight:CreateAnalysis,
+quicksight:DescribeTemplate,
+quicksight:DescribeTheme,
+quicksight:PassDataSet,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### List +
+quicksight:ListAnalyses
+ + +## Example +```sql +SELECT +region, +analysis_id, +aws_account_id +FROM awscc.quicksight.analyses +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/analysis/index.md b/docs/awscc-docs/providers/awscc/quicksight/analysis/index.md new file mode 100644 index 0000000000..a257dbe545 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/analysis/index.md @@ -0,0 +1,108 @@ +--- +title: analysis +hide_title: false +hide_table_of_contents: false +keywords: + - analysis + - 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 +--- +Gets an individual analysis resource + +## Overview + + + + + +
Nameanalysis
TypeResource
Descriptionanalysis
Idawscc.quicksight.analysis
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
analysis_idstring
arnstring
aws_account_idstring
created_timestring
data_set_arnsarray
definitionobject
errorsarray
last_updated_timestring
namestring
parametersobject
permissionsarray
sheetsarray
source_entityobject
statusstring
tagsarray
theme_arnstring
validation_strategyobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the analysis resource, the following permissions are required: + +### Read +
+quicksight:DescribeAnalysis,
+quicksight:DescribeAnalysisPermissions,
+quicksight:ListTagsForResource
+ +### Update +
+quicksight:DescribeAnalysis,
+quicksight:DescribeAnalysisPermissions,
+quicksight:UpdateAnalysis,
+quicksight:UpdateAnalysisPermissions,
+quicksight:DescribeTemplate,
+quicksight:DescribeTheme,
+quicksight:PassDataSet,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### Delete +
+quicksight:DescribeAnalysis,
+quicksight:DeleteAnalysis
+ + +## Example +```sql +SELECT +region, +analysis_id, +arn, +aws_account_id, +created_time, +data_set_arns, +definition, +errors, +last_updated_time, +name, +parameters, +permissions, +sheets, +source_entity, +status, +tags, +theme_arn, +validation_strategy +FROM awscc.quicksight.analysis +WHERE region = 'us-east-1' +AND data__Identifier = '<AnalysisId>' +AND data__Identifier = '<AwsAccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md b/docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md new file mode 100644 index 0000000000..39236c002e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md @@ -0,0 +1,114 @@ +--- +title: dashboard +hide_title: false +hide_table_of_contents: false +keywords: + - dashboard + - 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 +--- +Gets an individual dashboard resource + +## Overview + + + + + +
Namedashboard
TypeResource
Descriptiondashboard
Idawscc.quicksight.dashboard
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
created_timestring
dashboard_idstring
dashboard_publish_optionsobject
definitionobject
last_published_timestring
last_updated_timestring
link_entitiesarray
link_sharing_configurationobject
namestring
parametersobject
permissionsarray
source_entityobject
tagsarray
theme_arnstring
validation_strategyobject
versionobject
version_descriptionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dashboard resource, the following permissions are required: + +### Read +
+quicksight:DescribeDashboard,
+quicksight:DescribeDashboardPermissions,
+quicksight:ListTagsForResource
+ +### Update +
+quicksight:DescribeDashboard,
+quicksight:DescribeDashboardPermissions,
+quicksight:UpdateDashboard,
+quicksight:UpdateDashboardLinks,
+quicksight:UpdateDashboardPermissions,
+quicksight:UpdateDashboardPublishedVersion,
+quicksight:DescribeTemplate,
+quicksight:DescribeTheme,
+quicksight:PassDataSet,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### Delete +
+quicksight:DescribeDashboard,
+quicksight:DeleteDashboard
+ + +## Example +```sql +SELECT +region, +arn, +aws_account_id, +created_time, +dashboard_id, +dashboard_publish_options, +definition, +last_published_time, +last_updated_time, +link_entities, +link_sharing_configuration, +name, +parameters, +permissions, +source_entity, +tags, +theme_arn, +validation_strategy, +version, +version_description +FROM awscc.quicksight.dashboard +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +AND data__Identifier = '<DashboardId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md b/docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md new file mode 100644 index 0000000000..ef71b53fba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md @@ -0,0 +1,68 @@ +--- +title: dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards + - 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 +--- +Retrieves a list of dashboards in a region + +## Overview + + + + + +
Namedashboards
TypeResource
Descriptiondashboards
Idawscc.quicksight.dashboards
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
dashboard_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dashboards resource, the following permissions are required: + +### Create +
+quicksight:DescribeDashboard,
+quicksight:DescribeDashboardPermissions,
+quicksight:CreateDashboard,
+quicksight:DescribeTemplate,
+quicksight:DescribeTheme,
+quicksight:PassDataSet,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### List +
+quicksight:ListDashboards
+ + +## Example +```sql +SELECT +region, +aws_account_id, +dashboard_id +FROM awscc.quicksight.dashboards +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_set/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_set/index.md new file mode 100644 index 0000000000..24c8f9c236 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/data_set/index.md @@ -0,0 +1,128 @@ +--- +title: data_set +hide_title: false +hide_table_of_contents: false +keywords: + - data_set + - 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 +--- +Gets an individual data_set resource + +## Overview + + + + + +
Namedata_set
TypeResource
Descriptiondata_set
Idawscc.quicksight.data_set
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the resource.</p>
aws_account_idstring
column_groupsarray<p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>
column_level_permission_rulesarray
consumed_spice_capacity_in_bytesnumber<p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't<br/> imported into SPICE.</p>
created_timestring<p>The time that this dataset was created.</p>
data_set_idstring
dataset_parametersarray<p>The parameters declared in the dataset.</p>
field_foldersobject
import_modestring
last_updated_timestring<p>The last time that this dataset was updated.</p>
logical_table_mapobject
namestring<p>The display name for the dataset.</p>
output_columnsarray<p>The list of columns after all transforms. These columns are available in templates,<br/> analyses, and dashboards.</p>
permissionsarray<p>A list of resource permissions on the dataset.</p>
physical_table_mapobject
row_level_permission_data_setobject
row_level_permission_tag_configurationobject
tagsarray<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
ingestion_wait_policyobject
data_set_usage_configurationobject
data_set_refresh_propertiesobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_set resource, the following permissions are required: + +### Read +
+quicksight:DescribeDataSet,
+quicksight:DescribeDataSetPermissions,
+quicksight:ListTagsForResource,
+quicksight:DescribeDataSetRefreshProperties
+ +### Update +
+quicksight:DescribeDataSet,
+quicksight:DescribeDataSetPermissions,
+quicksight:PassDataSource,
+quicksight:UpdateDataSet,
+quicksight:UpdateDataSetPermissions,
+quicksight:PassDataSet,
+quicksight:DescribeIngestion,
+quicksight:ListIngestions,
+quicksight:CancelIngestion,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource,
+quicksight:PutDataSetRefreshProperties,
+quicksight:DescribeDataSetRefreshProperties,
+quicksight:DeleteDataSetRefreshProperties
+ +### Delete +
+quicksight:DescribeDataSet,
+quicksight:DeleteDataSet,
+quicksight:ListTagsForResource,
+quicksight:DescribeIngestion,
+quicksight:DeleteDataSetRefreshProperties,
+quicksight:DescribeDataSetRefreshProperties
+ + +## Example +```sql +SELECT +region, +arn, +aws_account_id, +column_groups, +column_level_permission_rules, +consumed_spice_capacity_in_bytes, +created_time, +data_set_id, +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, +data_set_usage_configuration, +data_set_refresh_properties +FROM awscc.quicksight.data_set +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +AND data__Identifier = '<DataSetId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md new file mode 100644 index 0000000000..f882c02af6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md @@ -0,0 +1,71 @@ +--- +title: data_sets +hide_title: false +hide_table_of_contents: false +keywords: + - data_sets + - 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 +--- +Retrieves a list of data_sets in a region + +## Overview + + + + + +
Namedata_sets
TypeResource
Descriptiondata_sets
Idawscc.quicksight.data_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
data_set_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_sets resource, the following permissions are required: + +### Create +
+quicksight:DescribeDataSet,
+quicksight:DescribeDataSetPermissions,
+quicksight:DescribeIngestion,
+quicksight:ListIngestions,
+quicksight:CreateDataSet,
+quicksight:PassDataSource,
+quicksight:PassDataSet,
+quicksight:TagResource,
+quicksight:ListTagsForResource,
+quicksight:DescribeDataSetRefreshProperties,
+quicksight:PutDataSetRefreshProperties
+ +### List +
+quicksight:DescribeDataSet,
+quicksight:ListDataSets
+ + +## Example +```sql +SELECT +region, +aws_account_id, +data_set_id +FROM awscc.quicksight.data_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_source/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_source/index.md new file mode 100644 index 0000000000..b768668674 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/data_source/index.md @@ -0,0 +1,105 @@ +--- +title: data_source +hide_title: false +hide_table_of_contents: false +keywords: + - data_source + - 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 +--- +Gets an individual data_source resource + +## Overview + + + + + +
Namedata_source
TypeResource
Descriptiondata_source
Idawscc.quicksight.data_source
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
alternate_data_source_parametersarray<p>A set of alternate data source parameters that you want to share for the credentials<br/> stored with this data source. The credentials are applied in tandem with the data source<br/> parameters when you copy a data source by using a create or update request. The API<br/> operation compares the <code>DataSourceParameters</code> structure that's in the request<br/> with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the<br/> structures are an exact match, the request is allowed to use the credentials from this<br/> existing data source. If the <code>AlternateDataSourceParameters</code> list is null,<br/> the <code>Credentials</code> originally used with this <code>DataSourceParameters</code><br/> are automatically allowed.</p>
arnstring<p>The Amazon Resource Name (ARN) of the data source.</p>
aws_account_idstring
created_timestring<p>The time that this data source was created.</p>
credentialsobject
data_source_idstring
data_source_parametersobject
error_infoobject
last_updated_timestring<p>The last time that this data source was updated.</p>
namestring<p>A display name for the data source.</p>
permissionsarray<p>A list of resource permissions on the data source.</p>
ssl_propertiesobject
statusstring
tagsarray<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p>
typestring
vpc_connection_propertiesobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_source resource, the following permissions are required: + +### Read +
+quicksight:DescribeDataSource,
+quicksight:DescribeDataSourcePermissions,
+quicksight:ListTagsForResource
+ +### Update +
+quicksight:DescribeDataSource,
+quicksight:DescribeDataSourcePermissions,
+quicksight:UpdateDataSource,
+quicksight:UpdateDataSourcePermissions,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### Delete +
+quicksight:DescribeDataSource,
+quicksight:DescribeDataSourcePermissions,
+quicksight:DeleteDataSource,
+quicksight:ListTagsForResource
+ + +## Example +```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, +tags, +type, +vpc_connection_properties +FROM awscc.quicksight.data_source +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +AND data__Identifier = '<DataSourceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md new file mode 100644 index 0000000000..8ec814bb19 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md @@ -0,0 +1,65 @@ +--- +title: data_sources +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources + - 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 +--- +Retrieves a list of data_sources in a region + +## Overview + + + + + +
Namedata_sources
TypeResource
Descriptiondata_sources
Idawscc.quicksight.data_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
data_source_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +
+quicksight:CreateDataSource,
+quicksight:DescribeDataSource,
+quicksight:DescribeDataSourcePermissions,
+quicksight:TagResource,
+quicksight:ListTagsForResource
+ +### List +
+quicksight:DescribeDataSource,
+quicksight:ListDataSources
+ + +## Example +```sql +SELECT +region, +aws_account_id, +data_source_id +FROM awscc.quicksight.data_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/index.md b/docs/awscc-docs/providers/awscc/quicksight/index.md new file mode 100644 index 0000000000..adbdf7e459 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/index.md @@ -0,0 +1,55 @@ +--- +title: quicksight +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The quicksight service documentation. + +:::info Service Summary + +
+
+total resources: 18
+total selectable resources: 18
+total methods: 18
+
+
+ +::: + +## Resources +
+
+analyses
+analysis
+dashboard
+dashboards
+data_set
+data_sets
+data_source
+data_sources
+refresh_schedule +
+
+refresh_schedules
+template
+templates
+theme
+themes
+topic
+topics
+vpc_connection
+vpc_connections +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/quicksight/refresh_schedule/index.md b/docs/awscc-docs/providers/awscc/quicksight/refresh_schedule/index.md new file mode 100644 index 0000000000..859dfc5794 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/refresh_schedule/index.md @@ -0,0 +1,73 @@ +--- +title: refresh_schedule +hide_title: false +hide_table_of_contents: false +keywords: + - refresh_schedule + - 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 +--- +Gets an individual refresh_schedule resource + +## Overview + + + + + +
Namerefresh_schedule
TypeResource
Descriptionrefresh_schedule
Idawscc.quicksight.refresh_schedule
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the data source.</p>
aws_account_idstring
data_set_idstring
scheduleobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the refresh_schedule resource, the following permissions are required: + +### Update +
+quicksight:UpdateRefreshSchedule,
+quicksight:DescribeRefreshSchedule
+ +### Delete +
+quicksight:DeleteRefreshSchedule,
+quicksight:DescribeRefreshSchedule
+ +### Read +
+quicksight:DescribeRefreshSchedule
+ + +## Example +```sql +SELECT +region, +arn, +aws_account_id, +data_set_id, +schedule +FROM awscc.quicksight.refresh_schedule +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +AND data__Identifier = '<DataSetId>' +AND data__Identifier = '<Schedule/ScheduleId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md b/docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md new file mode 100644 index 0000000000..1616c1ec44 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md @@ -0,0 +1,63 @@ +--- +title: refresh_schedules +hide_title: false +hide_table_of_contents: false +keywords: + - refresh_schedules + - 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 +--- +Retrieves a list of refresh_schedules in a region + +## Overview + + + + + +
Namerefresh_schedules
TypeResource
Descriptionrefresh_schedules
Idawscc.quicksight.refresh_schedules
+ +## Fields + + + + + + + +
NameDatatypeDescription
aws_account_idstring
data_set_idstring
schedule/schedule_idstring<p>An unique identifier for the refresh schedule.</p>
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the refresh_schedules resource, the following permissions are required: + +### Create +
+quicksight:CreateRefreshSchedule,
+quicksight:DescribeRefreshSchedule
+ +### List +
+quicksight:ListRefreshSchedules
+ + +## Example +```sql +SELECT +region, +aws_account_id, +data_set_id, +schedule/schedule_id +FROM awscc.quicksight.refresh_schedules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/template/index.md b/docs/awscc-docs/providers/awscc/quicksight/template/index.md new file mode 100644 index 0000000000..200180956a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/template/index.md @@ -0,0 +1,98 @@ +--- +title: template +hide_title: false +hide_table_of_contents: false +keywords: + - template + - 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 +--- +Gets an individual template resource + +## Overview + + + + + +
Nametemplate
TypeResource
Descriptiontemplate
Idawscc.quicksight.template
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
created_timestring
definitionobject
last_updated_timestring
namestring
permissionsarray
source_entityobject
tagsarray
template_idstring
validation_strategyobject
versionobject
version_descriptionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the template resource, the following permissions are required: + +### Read +
+quicksight:DescribeTemplate,
+quicksight:DescribeTemplatePermissions,
+quicksight:ListTagsForResource
+ +### Update +
+quicksight:DescribeTemplate,
+quicksight:DescribeTemplatePermissions,
+quicksight:UpdateTemplate,
+quicksight:UpdateTemplatePermissions,
+quicksight:PassDataSet,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### Delete +
+quicksight:DescribeTemplate,
+quicksight:DeleteTemplate
+ + +## Example +```sql +SELECT +region, +arn, +aws_account_id, +created_time, +definition, +last_updated_time, +name, +permissions, +source_entity, +tags, +template_id, +validation_strategy, +version, +version_description +FROM awscc.quicksight.template +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +AND data__Identifier = '<TemplateId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/templates/index.md b/docs/awscc-docs/providers/awscc/quicksight/templates/index.md new file mode 100644 index 0000000000..fdcb3405c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/templates/index.md @@ -0,0 +1,66 @@ +--- +title: templates +hide_title: false +hide_table_of_contents: false +keywords: + - templates + - 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 +--- +Retrieves a list of templates in a region + +## Overview + + + + + +
Nametemplates
TypeResource
Descriptiontemplates
Idawscc.quicksight.templates
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
template_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Create +
+quicksight:DescribeTemplate,
+quicksight:DescribeTemplatePermissions,
+quicksight:CreateTemplate,
+quicksight:DescribeAnalysis,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### List +
+quicksight:ListTemplates
+ + +## Example +```sql +SELECT +region, +aws_account_id, +template_id +FROM awscc.quicksight.templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/theme/index.md b/docs/awscc-docs/providers/awscc/quicksight/theme/index.md new file mode 100644 index 0000000000..dfbe8f0f7d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/theme/index.md @@ -0,0 +1,97 @@ +--- +title: theme +hide_title: false +hide_table_of_contents: false +keywords: + - theme + - 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 +--- +Gets an individual theme resource + +## Overview + + + + + +
Nametheme
TypeResource
Descriptiontheme
Idawscc.quicksight.theme
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
base_theme_idstring
configurationobject
created_timestring
last_updated_timestring
namestring
permissionsarray
tagsarray
theme_idstring
typestring
versionobject
version_descriptionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the theme resource, the following permissions are required: + +### Read +
+quicksight:DescribeTheme,
+quicksight:DescribeThemePermissions,
+quicksight:ListTagsForResource
+ +### Update +
+quicksight:DescribeTheme,
+quicksight:DescribeThemePermissions,
+quicksight:UpdateTheme,
+quicksight:UpdateThemePermissions,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### Delete +
+quicksight:DescribeTheme,
+quicksight:DeleteTheme
+ + +## Example +```sql +SELECT +region, +arn, +aws_account_id, +base_theme_id, +configuration, +created_time, +last_updated_time, +name, +permissions, +tags, +theme_id, +type, +version, +version_description +FROM awscc.quicksight.theme +WHERE region = 'us-east-1' +AND data__Identifier = '<ThemeId>' +AND data__Identifier = '<AwsAccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/themes/index.md b/docs/awscc-docs/providers/awscc/quicksight/themes/index.md new file mode 100644 index 0000000000..70759922a8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/themes/index.md @@ -0,0 +1,65 @@ +--- +title: themes +hide_title: false +hide_table_of_contents: false +keywords: + - themes + - 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 +--- +Retrieves a list of themes in a region + +## Overview + + + + + +
Namethemes
TypeResource
Descriptionthemes
Idawscc.quicksight.themes
+ +## Fields + + + + + + +
NameDatatypeDescription
theme_idstring
aws_account_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the themes resource, the following permissions are required: + +### Create +
+quicksight:DescribeTheme,
+quicksight:DescribeThemePermissions,
+quicksight:CreateTheme,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource
+ +### List +
+quicksight:ListThemes
+ + +## Example +```sql +SELECT +region, +theme_id, +aws_account_id +FROM awscc.quicksight.themes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/topic/index.md b/docs/awscc-docs/providers/awscc/quicksight/topic/index.md new file mode 100644 index 0000000000..c92dc299d9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/topic/index.md @@ -0,0 +1,78 @@ +--- +title: topic +hide_title: false +hide_table_of_contents: false +keywords: + - topic + - 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 +--- +Gets an individual topic resource + +## Overview + + + + + +
Nametopic
TypeResource
Descriptiontopic
Idawscc.quicksight.topic
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
data_setsarray
descriptionstring
namestring
topic_idstring
user_experience_versionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic resource, the following permissions are required: + +### Read +
+quicksight:DescribeTopic
+ +### Update +
+quicksight:UpdateTopic,
+quicksight:PassDataSet,
+quicksight:DescribeTopicRefresh
+ +### Delete +
+quicksight:DeleteTopic
+ + +## Example +```sql +SELECT +region, +arn, +aws_account_id, +data_sets, +description, +name, +topic_id, +user_experience_version +FROM awscc.quicksight.topic +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +AND data__Identifier = '<TopicId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/topics/index.md b/docs/awscc-docs/providers/awscc/quicksight/topics/index.md new file mode 100644 index 0000000000..99b25a9af9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/topics/index.md @@ -0,0 +1,62 @@ +--- +title: topics +hide_title: false +hide_table_of_contents: false +keywords: + - topics + - 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 +--- +Retrieves a list of topics in a region + +## Overview + + + + + +
Nametopics
TypeResource
Descriptiontopics
Idawscc.quicksight.topics
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
topic_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topics resource, the following permissions are required: + +### Create +
+quicksight:CreateTopic,
+quicksight:PassDataSet,
+quicksight:DescribeTopicRefresh
+ +### List +
+quicksight:ListTopics
+ + +## Example +```sql +SELECT +region, +aws_account_id, +topic_id +FROM awscc.quicksight.topics +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md b/docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md new file mode 100644 index 0000000000..25b7fc50ca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md @@ -0,0 +1,101 @@ +--- +title: vpc_connection +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connection + - 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 +--- +Gets an individual vpc_connection resource + +## Overview + + + + + +
Namevpc_connection
TypeResource
Descriptionvpc_connection
Idawscc.quicksight.vpc_connection
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
namestring
v_pc_connection_idstring
v_pc_idstring
security_group_idsarray
subnet_idsarray
dns_resolversarray
statusstring
availability_statusstring
network_interfacesarray
role_arnstring
created_timestring
last_updated_timestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_connection resource, the following permissions are required: + +### Read +
+quicksight:DescribeVPCConnection,
+quicksight:ListTagsForResource
+ +### Update +
+quicksight:DescribeVPCConnection,
+quicksight:UpdateVPCConnection,
+quicksight:TagResource,
+quicksight:UntagResource,
+quicksight:ListTagsForResource,
+iam:PassRole
+ +### Delete +
+quicksight:DescribeVPCConnection,
+quicksight:DeleteVPCConnection,
+quicksight:ListTagsForResource,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +arn, +aws_account_id, +name, +v_pc_connection_id, +v_pc_id, +security_group_ids, +subnet_ids, +dns_resolvers, +status, +availability_status, +network_interfaces, +role_arn, +created_time, +last_updated_time, +tags +FROM awscc.quicksight.vpc_connection +WHERE region = 'us-east-1' +AND data__Identifier = '<AwsAccountId>' +AND data__Identifier = '<VPCConnectionId>' +``` diff --git a/docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md b/docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md new file mode 100644 index 0000000000..cf6b88ddb9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md @@ -0,0 +1,64 @@ +--- +title: vpc_connections +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connections + - 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 +--- +Retrieves a list of vpc_connections in a region + +## Overview + + + + + +
Namevpc_connections
TypeResource
Descriptionvpc_connections
Idawscc.quicksight.vpc_connections
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
v_pc_connection_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vpc_connections resource, the following permissions are required: + +### Create +
+quicksight:CreateVPCConnection,
+quicksight:DescribeVPCConnection,
+quicksight:ListTagsForResource,
+quicksight:TagResource,
+iam:PassRole
+ +### List +
+quicksight:ListVPCConnections
+ + +## Example +```sql +SELECT +region, +aws_account_id, +v_pc_connection_id +FROM awscc.quicksight.vpc_connections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ram/index.md b/docs/awscc-docs/providers/awscc/ram/index.md new file mode 100644 index 0000000000..c322cc2600 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ram/index.md @@ -0,0 +1,39 @@ +--- +title: ram +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ram service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+permission +
+
+permissions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ram/permission/index.md b/docs/awscc-docs/providers/awscc/ram/permission/index.md new file mode 100644 index 0000000000..2aff87dd1f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ram/permission/index.md @@ -0,0 +1,86 @@ +--- +title: permission +hide_title: false +hide_table_of_contents: false +keywords: + - permission + - 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 +--- +Gets an individual permission resource + +## Overview + + + + + +
Namepermission
TypeResource
Descriptionpermission
Idawscc.ram.permission
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe name of the permission.
versionstringVersion of the permission.
is_resource_type_defaultbooleanSet to true to use this as the default permission.
permission_typestring
resource_typestringThe resource type this permission can be used with.
policy_templateobjectPolicy template for the permission.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permission resource, the following permissions are required: + +### Read +
+ram:GetPermission
+ +### Update +
+ram:CreatePermissionVersion,
+ram:DeletePermissionVersion,
+ram:SetDefaultPermissionVersion,
+ram:GetPermission,
+ram:ReplacePermissionAssociations,
+ram:ListReplacePermissionAssociationsWork,
+ram:ListPermissionVersions,
+ram:UntagResource,
+ram:TagResource
+ +### Delete +
+ram:DeletePermissionVersion,
+ram:DeletePermission
+ + +## Example +```sql +SELECT +region, +arn, +name, +version, +is_resource_type_default, +permission_type, +resource_type, +policy_template, +tags +FROM awscc.ram.permission +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ram/permissions/index.md b/docs/awscc-docs/providers/awscc/ram/permissions/index.md new file mode 100644 index 0000000000..fb090719b1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ram/permissions/index.md @@ -0,0 +1,60 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - permissions + - 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 +--- +Retrieves a list of permissions in a region + +## Overview + + + + + +
Namepermissions
TypeResource
Descriptionpermissions
Idawscc.ram.permissions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +
+ram:CreatePermission,
+ram:TagResource
+ +### List +
+ram:ListPermissions,
+ram:ListPermissionVersions
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ram.permissions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/customdb_engine_version/index.md b/docs/awscc-docs/providers/awscc/rds/customdb_engine_version/index.md new file mode 100644 index 0000000000..904795a7a2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/customdb_engine_version/index.md @@ -0,0 +1,86 @@ +--- +title: customdb_engine_version +hide_title: false +hide_table_of_contents: false +keywords: + - customdb_engine_version + - 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 +--- +Gets an individual customdb_engine_version resource + +## Overview + + + + + +
Namecustomdb_engine_version
TypeResource
Descriptioncustomdb_engine_version
Idawscc.rds.customdb_engine_version
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
database_installation_files_s3_bucket_namestringThe 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`.
database_installation_files_s3_prefixstringThe 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.
descriptionstringAn optional description of your CEV.
enginestringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
engine_versionstringThe 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.
k_ms_key_idstringThe AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.
manifeststringThe 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.
d_bengine_version_arnstringThe ARN of the custom engine version.
statusstringThe availability status to be assigned to the CEV.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the customdb_engine_version resource, the following permissions are required: + +### Read +
+rds:DescribeDBEngineVersions
+ +### Update +
+rds:AddTagsToResource,
+rds:DescribeDBEngineVersions,
+rds:ModifyCustomDBEngineVersion,
+rds:RemoveTagsFromResource
+ +### Delete +
+rds:DeleteCustomDBEngineVersion,
+rds:DescribeDBEngineVersions
+ + +## Example +```sql +SELECT +region, +database_installation_files_s3_bucket_name, +database_installation_files_s3_prefix, +description, +engine, +engine_version, +k_ms_key_id, +manifest, +d_bengine_version_arn, +status, +tags +FROM awscc.rds.customdb_engine_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Engine>' +AND data__Identifier = '<EngineVersion>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/customdb_engine_versions/index.md b/docs/awscc-docs/providers/awscc/rds/customdb_engine_versions/index.md new file mode 100644 index 0000000000..c2694a06c9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/customdb_engine_versions/index.md @@ -0,0 +1,74 @@ +--- +title: customdb_engine_versions +hide_title: false +hide_table_of_contents: false +keywords: + - customdb_engine_versions + - 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 +--- +Retrieves a list of customdb_engine_versions in a region + +## Overview + + + + + +
Namecustomdb_engine_versions
TypeResource
Descriptioncustomdb_engine_versions
Idawscc.rds.customdb_engine_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
enginestringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
engine_versionstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the customdb_engine_versions resource, the following permissions are required: + +### Create +
+kms:CreateGrant,
+kms:DescribeKey,
+mediaimport:CreateDatabaseBinarySnapshot,
+rds:AddTagsToResource,
+rds:CreateCustomDBEngineVersion,
+rds:DescribeDBEngineVersions,
+rds:ModifyCustomDBEngineVersion,
+s3:CreateBucket,
+s3:GetObject,
+s3:GetObjectAcl,
+s3:GetObjectTagging,
+s3:ListBucket,
+s3:PutBucketObjectLockConfiguration,
+s3:PutBucketPolicy,
+s3:PutBucketVersioning
+ +### List +
+rds:DescribeDBEngineVersions
+ + +## Example +```sql +SELECT +region, +engine, +engine_version +FROM awscc.rds.customdb_engine_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_cluster/index.md b/docs/awscc-docs/providers/awscc/rds/db_cluster/index.md new file mode 100644 index 0000000000..32e7eaeba4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_cluster/index.md @@ -0,0 +1,198 @@ +--- +title: db_cluster +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster + - 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 +--- +Gets an individual db_cluster resource + +## Overview + + + + + +
Namedb_cluster
TypeResource
Descriptiondb_cluster
Idawscc.rds.db_cluster
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
endpointobject
read_endpointobject
allocated_storageintegerThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
associated_rolesarrayProvides 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.
availability_zonesarrayA 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.
auto_minor_version_upgradebooleanA 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.
backtrack_windowintegerThe target backtrack window, in seconds. To disable backtracking, set this value to 0.
backup_retention_periodintegerThe number of days for which automated backups are retained.
copy_tags_to_snapshotbooleanA 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.
database_namestringThe 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.
d_bcluster_arnstringThe Amazon Resource Name (ARN) for the DB cluster.
d_bcluster_instance_classstringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
d_bcluster_resource_idstringThe AWS Region-unique, immutable identifier for the DB cluster.
d_binstance_parameter_group_namestringThe name of the DB parameter group to apply to all instances of the DB cluster.
d_bsystem_idstringReserved for future use.
global_cluster_identifierstringIf 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.<br/><br/>If you aren't configuring a global database cluster, don't specify this property.
d_bcluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
d_bcluster_parameter_group_namestringThe name of the DB cluster parameter group to associate with this DB cluster.
d_bsubnet_group_namestringA DB subnet group that you want to associate with this DB cluster.
deletion_protectionbooleanA 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.
domainstringThe Active Directory directory ID to create the DB cluster in.
domain_ia_mrole_namestringSpecify the name of the IAM role to be used when making API calls to the Directory Service.
enable_cloudwatch_logs_exportsarrayThe 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.
enable_global_write_forwardingbooleanSpecifies 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.
enable_http_endpointbooleanA value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.
enable_ia_mdatabase_authenticationbooleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
enginestringThe 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
engine_modestringThe DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
engine_versionstringThe version number of the database engine to use.
manage_master_user_passwordbooleanA value that indicates whether to manage the master user password with AWS Secrets Manager.
iopsintegerThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
kms_key_idstringThe 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.
master_usernamestringThe name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
master_user_passwordstringThe master password for the DB instance.
master_user_secretobjectContains the secret managed by RDS in AWS Secrets Manager for the master user password.
monitoring_intervalintegerThe 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.
monitoring_role_arnstringThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
network_typestringThe network type of the DB cluster.
performance_insights_enabledbooleanA value that indicates whether to turn on Performance Insights for the DB cluster.
performance_insights_kms_key_idstringThe Amazon Web Services KMS key identifier for encryption of Performance Insights data.
performance_insights_retention_periodintegerThe amount of time, in days, to retain Performance Insights data.
portintegerThe 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.
preferred_backup_windowstringThe 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.
preferred_maintenance_windowstringThe 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.
publicly_accessiblebooleanA value that indicates whether the DB cluster is publicly accessible.
replication_source_identifierstringThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
restore_to_timestringThe 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
restore_typestringThe type of restore to be performed. You can specify one of the following values:<br/>full-copy - The new DB cluster is restored as a full copy of the source DB cluster.<br/>copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
serverless_v2_scaling_configurationobjectContains the scaling configuration of an Aurora Serverless v2 DB cluster.
scaling_configurationobjectThe ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
snapshot_identifierstringThe identifier for the DB snapshot or DB cluster snapshot to restore from.<br/>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.<br/>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.
source_db_cluster_identifierstringThe identifier of the source DB cluster from which to restore.
source_regionstringThe AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
storage_encryptedbooleanIndicates whether the DB instance is encrypted.<br/>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.
storage_typestringSpecifies the storage type to be associated with the DB cluster.
tagsarrayAn array of key-value pairs to apply to this resource.
use_latest_restorable_timebooleanA 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.
vpc_security_group_idsarrayA list of EC2 VPC security groups to associate with this DB cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_cluster resource, the following permissions are required: + +### Read +
+rds:DescribeDBClusters
+ +### Update +
+ec2:DescribeSecurityGroups,
+iam:PassRole,
+rds:AddRoleToDBCluster,
+rds:AddTagsToResource,
+rds:DescribeDBClusters,
+rds:DescribeDBSubnetGroups,
+rds:DescribeEvents,
+rds:DescribeGlobalClusters,
+rds:DisableHttpEndpoint,
+rds:EnableHttpEndpoint,
+rds:ModifyDBCluster,
+rds:ModifyDBInstance,
+rds:RemoveFromGlobalCluster,
+rds:RemoveRoleFromDBCluster,
+rds:RemoveTagsFromResource,
+secretsmanager:CreateSecret,
+secretsmanager:TagResource
+ +### Delete +
+rds:CreateDBClusterSnapshot,
+rds:DeleteDBCluster,
+rds:DeleteDBInstance,
+rds:DescribeDBClusters,
+rds:DescribeGlobalClusters,
+rds:RemoveFromGlobalCluster
+ + +## Example +```sql +SELECT +region, +endpoint, +read_endpoint, +allocated_storage, +associated_roles, +availability_zones, +auto_minor_version_upgrade, +backtrack_window, +backup_retention_period, +copy_tags_to_snapshot, +database_name, +d_bcluster_arn, +d_bcluster_instance_class, +d_bcluster_resource_id, +d_binstance_parameter_group_name, +d_bsystem_id, +global_cluster_identifier, +d_bcluster_identifier, +d_bcluster_parameter_group_name, +d_bsubnet_group_name, +deletion_protection, +domain, +domain_ia_mrole_name, +enable_cloudwatch_logs_exports, +enable_global_write_forwarding, +enable_http_endpoint, +enable_ia_mdatabase_authentication, +engine, +engine_mode, +engine_version, +manage_master_user_password, +iops, +kms_key_id, +master_username, +master_user_password, +master_user_secret, +monitoring_interval, +monitoring_role_arn, +network_type, +performance_insights_enabled, +performance_insights_kms_key_id, +performance_insights_retention_period, +port, +preferred_backup_window, +preferred_maintenance_window, +publicly_accessible, +replication_source_identifier, +restore_to_time, +restore_type, +serverless_v2_scaling_configuration, +scaling_configuration, +snapshot_identifier, +source_db_cluster_identifier, +source_region, +storage_encrypted, +storage_type, +tags, +use_latest_restorable_time, +vpc_security_group_ids +FROM awscc.rds.db_cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<DBClusterIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_group/index.md b/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_group/index.md new file mode 100644 index 0000000000..425700fb70 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_group/index.md @@ -0,0 +1,82 @@ +--- +title: db_cluster_parameter_group +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_parameter_group + - 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 +--- +Gets an individual db_cluster_parameter_group resource + +## Overview + + + + + +
Namedb_cluster_parameter_group
TypeResource
Descriptiondb_cluster_parameter_group
Idawscc.rds.db_cluster_parameter_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstringA friendly description for this DB cluster parameter group.
familystringThe 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.
parametersobjectAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
d_bcluster_parameter_group_namestring
tagsarrayThe list of tags for the cluster parameter group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_cluster_parameter_group resource, the following permissions are required: + +### Read +
+rds:DescribeDBClusterParameterGroups,
+rds:DescribeDBClusterParameters,
+rds:DescribeEngineDefaultClusterParameters,
+rds:ListTagsForResource
+ +### Update +
+rds:AddTagsToResource,
+rds:DescribeDBClusterParameterGroups,
+rds:DescribeDBClusterParameters,
+rds:DescribeDBClusters,
+rds:DescribeEngineDefaultClusterParameters,
+rds:ListTagsForResource,
+rds:ModifyDBClusterParameterGroup,
+rds:RemoveTagsFromResource,
+rds:ResetDBClusterParameterGroup
+ +### Delete +
+rds:DeleteDBClusterParameterGroup
+ + +## Example +```sql +SELECT +region, +description, +family, +parameters, +d_bcluster_parameter_group_name, +tags +FROM awscc.rds.db_cluster_parameter_group +WHERE region = 'us-east-1' +AND data__Identifier = '<DBClusterParameterGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_groups/index.md b/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_groups/index.md new file mode 100644 index 0000000000..dc141370ee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_groups/index.md @@ -0,0 +1,67 @@ +--- +title: db_cluster_parameter_groups +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_parameter_groups + - 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 +--- +Retrieves a list of db_cluster_parameter_groups in a region + +## Overview + + + + + +
Namedb_cluster_parameter_groups
TypeResource
Descriptiondb_cluster_parameter_groups
Idawscc.rds.db_cluster_parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
d_bcluster_parameter_group_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_cluster_parameter_groups resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+rds:AddTagsToResource,
+rds:CreateDBClusterParameterGroup,
+rds:DescribeDBClusterParameterGroups,
+rds:DescribeDBClusterParameters,
+rds:DescribeDBClusters,
+rds:DescribeEngineDefaultClusterParameters,
+rds:ListTagsForResource,
+rds:ModifyDBClusterParameterGroup,
+rds:RemoveTagsFromResource
+ +### List +
+rds:DescribeDBClusterParameterGroups
+ + +## Example +```sql +SELECT +region, +d_bcluster_parameter_group_name +FROM awscc.rds.db_cluster_parameter_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_clusters/index.md b/docs/awscc-docs/providers/awscc/rds/db_clusters/index.md new file mode 100644 index 0000000000..618903386b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_clusters/index.md @@ -0,0 +1,71 @@ +--- +title: db_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - db_clusters + - 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 +--- +Retrieves a list of db_clusters in a region + +## Overview + + + + + +
Namedb_clusters
TypeResource
Descriptiondb_clusters
Idawscc.rds.db_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
d_bcluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_clusters resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+iam:PassRole,
+rds:AddRoleToDBCluster,
+rds:AddTagsToResource,
+rds:CreateDBCluster,
+rds:CreateDBInstance,
+rds:DescribeDBClusters,
+rds:DescribeEvents,
+rds:EnableHttpEndpoint,
+rds:ModifyDBCluster,
+rds:RestoreDBClusterFromSnapshot,
+rds:RestoreDBClusterToPointInTime,
+secretsmanager:CreateSecret,
+secretsmanager:TagResource
+ +### List +
+rds:DescribeDBClusters
+ + +## Example +```sql +SELECT +region, +d_bcluster_identifier +FROM awscc.rds.db_clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_instance/index.md b/docs/awscc-docs/providers/awscc/rds/db_instance/index.md new file mode 100644 index 0000000000..49b2720c69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_instance/index.md @@ -0,0 +1,256 @@ +--- +title: db_instance +hide_title: false +hide_table_of_contents: false +keywords: + - db_instance + - 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 +--- +Gets an individual db_instance resource + +## Overview + + + + + +
Namedb_instance
TypeResource
Descriptiondb_instance
Idawscc.rds.db_instance
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
allocated_storagestringThe amount of storage in gibibytes (GiB) to be initially allocated for the database instance.<br/> 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). <br/> *Amazon Aurora* <br/> 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.<br/> *Db2* <br/> Constraints to the amount of storage for each storage type are the following:<br/> + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.<br/> + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.<br/> <br/> *MySQL* <br/> Constraints to the amount of storage for each storage type are the following: <br/> + General Purpose (SSD) storage (gp2): Must be an integer fro
allow_major_version_upgradebooleanA 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.<br/> 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.
associated_rolesarrayThe IAMlong (IAM) roles associated with the DB instance. <br/> *Amazon Aurora* <br/> Not applicable. The associated roles are managed by the DB cluster.
auto_minor_version_upgradebooleanA 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.
automatic_backup_replication_regionstringThe 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*.
availability_zonestringThe 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).<br/> 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.<br/> Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.<br/> Constraints:<br/> + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.<br/> + The specified Availability Zone must be in the same AWS-Region as the current endpoint.<br/> <br/> Example: ``us-east-1d``
backup_retention_periodintegerThe 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.<br/> *Amazon Aurora*<br/> Not applicable. The retention period for automated backups is managed by the DB cluster.<br/> Default: 1<br/> Constraints:<br/> + Must be a value from 0 to 35<br/> + Can't be set to 0 if the DB instance is a source to read replicas
c_acertificate_identifierstringThe identifier of the CA certificate for this DB instance.<br/> Specifying or updating this property triggers a reboot. For more information about CA certificate identifiers 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 CA certificate identifiers 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*.
certificate_detailsobjectThe details of the DB instance's server certificate.
certificate_rotation_restartbooleanSpecifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.<br/> 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.<br/> Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.<br/> 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:<br/> + 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.* <br/> + 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 Gui
character_set_namestringFor supported engines, indicates that the DB instance should be associated with the specified character set.<br/> *Amazon Aurora* <br/> 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).
copy_tags_to_snapshotbooleanSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.<br/> 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.
custom_ia_minstance_profilestringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.<br/> This setting is required for RDS Custom.<br/> Constraints:<br/> + The profile must exist in your account.<br/> + The profile must have an IAM role that Amazon EC2 has permissions to assume.<br/> + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.<br/> <br/> 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*.
d_bcluster_identifierstringThe identifier of the DB cluster that the instance will belong to.
d_bcluster_snapshot_identifierstringThe identifier for the Multi-AZ DB cluster snapshot to restore from.<br/> 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*.<br/> Constraints:<br/> + Must match the identifier of an existing Multi-AZ DB cluster snapshot.<br/> + Can't be specified when ``DBSnapshotIdentifier`` is specified.<br/> + Must be specified when ``DBSnapshotIdentifier`` isn't specified.<br/> + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.<br/> + Can't be the identifier of an Aurora DB cluster snapshot.
d_binstance_arnstring
d_binstance_classstringThe compute and memory capacity of the DB instance, for example, ``db.m4.large``. Not all DB instance classes are available in all AWS Regions, or for all database engines.<br/> For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/).
d_binstance_identifierstringA 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).<br/> 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*.<br/> 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.
dbi_resource_idstring
d_bnamestringThe meaning of this parameter differs according to the database engine you use.<br/> If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.<br/> *Amazon Aurora* <br/> Not applicable. The database name is managed by the DB cluster.<br/> *Db2* <br/> 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.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).<br/> + Can't be a word reserved by the specified database engine.<br/> <br/> *MySQL* <br/> 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.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Can't be a word reserved by the specified database engine<br/> <br/> *MariaDB* <br/> The name of the database to create when the DB instance is
d_bparameter_group_namestringThe 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.<br/> To list all of the available DB parameter group names, use the following command:<br/> ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text``<br/> 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.<br/> If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
d_bsecurity_groupsarrayA 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.<br/> 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.<br/> If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:<br/> + ``AllocatedStorage``<br/> + ``AutoMinorVersionUpgrade``<br/> + ``AvailabilityZone``<br/> + ``BackupRetentionPeriod``<br/> + ``CharacterSetName``<br/> + ``DBInstanceClass``<br/> + ``DBName``<br/> + ``DBParameterGroupName``<br/> + ``DBSecurityGroups``<br/> + ``DBSubnetGroupName``<br/> + ``Engine``<br/> + ``EngineVersion``<br/> + ``Iops``<br/> + ``LicenseModel``<br/> +
d_bsnapshot_identifierstringThe 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.<br/> 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.<br/> 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 *Amazo
d_bsubnet_group_namestringA 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. <br/> If there's no DB subnet group, then the DB instance isn't a VPC DB instance.<br/> 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*. <br/> *Amazon Aurora*<br/> Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
d_bsystem_idstringThe 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.
dedicated_log_volumebooleanIndicates whether the DB instance has a dedicated log volume (DLV) enabled.
delete_automated_backupsbooleanA 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.<br/> *Amazon Aurora*<br/> 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.
deletion_protectionbooleanA 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). <br/> *Amazon Aurora* <br/> 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.
domainstringThe 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.<br/> For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.
domain_auth_secret_arnstringThe ARN for the Secrets Manager secret with the credentials for the user joining the domain.<br/> Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``
domain_dns_ipsarrayThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.<br/> Constraints:<br/> + 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.<br/> <br/> Example: ``123.124.125.126,234.235.236.237``
domain_fqdnstringThe fully qualified domain name (FQDN) of an Active Directory domain.<br/> Constraints:<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``mymanagedADtest.mymanagedAD.mydomain``
domain_ia_mrole_namestringThe name of the IAM role to use when making API calls to the Directory Service.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (The domain is managed by the DB cluster.)<br/> + RDS Custom
domain_oustringThe Active Directory organizational unit for your DB instance to join.<br/> Constraints:<br/> + Must be in the distinguished name format.<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``
enable_cloudwatch_logs_exportsarrayThe 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*.<br/> *Amazon Aurora* <br/> Not applicable. CloudWatch Logs exports are managed by the DB cluster. <br/> *Db2* <br/> Valid values: ``diag.log``, ``notify.log`` <br/> *MariaDB* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Microsoft SQL Server* <br/> Valid values: ``agent``, ``error`` <br/> *MySQL* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Oracle* <br/> Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` <br/> *PostgreSQL* <br/> Valid values: ``postgresql``, ``upgrade``
enable_ia_mdatabase_authenticationbooleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.<br/> 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.* <br/> *Amazon Aurora* <br/> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
enable_performance_insightsbooleanSpecifies 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*.<br/> This setting doesn't apply to RDS Custom DB instances.
endpointobjectThe connection endpoint for the DB instance.<br/> The endpoint might not be shown for instances with the status of ``creating``.
enginestringThe name of the database engine that you want to use for this DB instance.<br/> Not every database engine is available in every AWS Region.<br/> When you are creating a DB instance, the ``Engine`` property is required.<br/> Valid Values:<br/> + ``aurora-mysql`` (for Aurora MySQL DB instances)<br/> + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances)<br/> + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances)<br/> + ``db2-ae``<br/> + ``db2-se``<br/> + ``mariadb``<br/> + ``mysql``<br/> + ``oracle-ee``<br/> + ``oracle-ee-cdb``<br/> + ``oracle-se2``<br/> + ``oracle-se2-cdb``<br/> + ``postgres``<br/> + ``sqlserver-ee``<br/> + ``sqlserver-se``<br/> + ``sqlserver-ex``<br/> + ``sqlserver-web``
engine_versionstringThe version number of the database engine to use.<br/> For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.<br/> 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.<br/> *Amazon Aurora* <br/> Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.<br/> *Db2* <br/> 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.*<br/> *MariaDB*<br/> 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.*<br/> *Microsoft SQL Server*<br/> See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
manage_master_user_passwordbooleanSpecifies whether to manage the master user password with AWS Secrets Manager.<br/> 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.* <br/> Constraints:<br/> + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
iopsintegerThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. <br/> 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*.<br/> If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.<br/> Constraints:<br/> + 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.<br/> + For RDS for SQL Server - Must be a multip
kms_key_idstringThe 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. <br/> 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.<br/> 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.<br/> If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is us
license_modelstringLicense model information for this DB instance.<br/> Valid Values:<br/> + Aurora MySQL - ``general-public-license``<br/> + Aurora PostgreSQL - ``postgresql-license``<br/> + 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.*<br/> + RDS for MariaDB - ``general-public-license``<br/> + RDS for Microsoft SQL Server - ``license-included``<br/> + RDS for MySQL - ``general-public-license``<br/> + RDS for Oracle - ``bring-your-own-license`` or ``license-included``<br/> + RDS for PostgreSQL - ``postgresql-license``<br/> <br/> 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.
master_usernamestringThe master user name for the DB instance.<br/> If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.<br/> When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.<br/> *Amazon Aurora* <br/> Not applicable. The name for the master user is managed by the DB cluster. <br/> *RDS for Db2* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MariaDB* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for Microsoft SQL Server* <br/> Constraints:<br/> + Must be 1 to 128 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MySQL* <br/> Constrain
master_user_passwordstringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@".<br/> *Amazon Aurora* <br/> Not applicable. The password for the master user is managed by the DB cluster.<br/> *RDS for Db2* <br/> Must contain from 8 to 255 characters.<br/> *RDS for MariaDB* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Microsoft SQL Server* <br/> Constraints: Must contain from 8 to 128 characters.<br/> *RDS for MySQL* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Oracle* <br/> Constraints: Must contain from 8 to 30 characters.<br/> *RDS for PostgreSQL* <br/> Constraints: Must contain from 8 to 128 characters.
master_user_secretobjectThe secret managed by RDS in AWS Secrets Manager for the master user password.<br/> 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.*
max_allocated_storageintegerThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.<br/> 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*.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (Storage is managed by the DB cluster.)<br/> + RDS Custom
monitoring_intervalintegerThe 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.<br/> If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.<br/> This setting doesn't apply to RDS Custom.<br/> Valid Values: ``0, 1, 5, 10, 15, 30, 60``
monitoring_role_arnstringThe 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*.<br/> If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.<br/> This setting doesn't apply to RDS Custom DB instances.
multi_azbooleanSpecifies 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. <br/> 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*.<br/> *Amazon Aurora* <br/> Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set.
nchar_character_set_namestringThe name of the NCHAR character set for the Oracle DB instance.<br/> This setting doesn't apply to RDS Custom DB instances.
network_typestringThe network type of the DB instance.<br/> Valid values:<br/> + ``IPV4`` <br/> + ``DUAL`` <br/> <br/> 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``).<br/> 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.*
option_group_namestringIndicates that the DB instance should be associated with the specified option group.<br/> 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.
performance_insights_km_skey_idstringThe AWS KMS key identifier for encryption of Performance Insights data.<br/> The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.<br/> 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.<br/> 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).
performance_insights_retention_periodintegerThe number of days to retain Performance Insights data.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Valid Values:<br/> + ``7`` <br/> + *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)<br/> + ``731`` <br/> <br/> Default: ``7`` days<br/> If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.
portstringThe port number on which the database accepts connections.<br/> *Amazon Aurora* <br/> Not applicable. The port number is managed by the DB cluster.<br/> *Db2* <br/> Default value: ``50000``
preferred_backup_windowstringThe 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.* <br/> Constraints:<br/> + Must be in the format ``hh24:mi-hh24:mi``.<br/> + Must be in Universal Coordinated Time (UTC).<br/> + Must not conflict with the preferred maintenance window.<br/> + Must be at least 30 minutes.<br/> <br/> *Amazon Aurora* <br/> Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
preferred_maintenance_windowstringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).<br/> Format: ``ddd:hh24:mi-ddd:hh24:mi`` <br/> 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.* <br/> 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.<br/> Constraints: Minimum 30-minute window.
processor_featuresarrayThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.<br/> This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
promotion_tierintegerThe 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*.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Default: ``1`` <br/> Valid Values: ``0 - 15``
publicly_accessiblebooleanIndicates 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. <br/> 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*.
replica_modestringThe 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*.<br/> This setting is only supported in RDS for Oracle.<br/> Default: ``open-read-only``<br/> Valid Values: ``open-read-only`` or ``mounted``
restore_timestringThe date and time to restore from.<br/> Constraints:<br/> + Must be a time in Universal Coordinated Time (UTC) format.<br/> + Must be before the latest restorable time for the DB instance.<br/> + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled.<br/> <br/> Example: ``2009-09-07T23:45:00Z``
source_db_cluster_identifierstringThe 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.<br/> Constraints:<br/> + Must be the identifier of an existing Multi-AZ DB cluster.<br/> + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.<br/> + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.<br/> + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
source_dbi_resource_idstringThe resource ID of the source DB instance from which to restore.
source_db_instance_automated_backups_arnstringThe 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``.<br/> This setting doesn't apply to RDS Custom.
source_db_instance_identifierstringIf 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*.<br/> 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*.<br/> 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.<br/> + 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
source_regionstringThe ID of the region that contains the source DB instance for the read replica.
storage_encryptedbooleanA value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.<br/> If you specify the ``KmsKeyId`` property, then you must enable encryption.<br/> 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.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``.<br/> *Amazon Aurora*<br/> Not applicable. The encrypt
storage_typestringSpecifies the storage type to be associated with the DB instance.<br/> Valid values: ``gp2 | gp3 | io1 | standard`` <br/> The ``standard`` value is also known as magnetic.<br/> If you specify ``io1`` or ``gp3``, you must also include a value for the ``Iops`` parameter. <br/> Default: ``io1`` if the ``Iops`` parameter is specified, otherwise ``gp2`` <br/> For more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
storage_throughputintegerSpecifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. <br/> This setting doesn't apply to RDS Custom or Amazon Aurora.
tagsarrayAn optional array of key-value pairs to apply to this DB instance.
tde_credential_arnstring
tde_credential_passwordstring
timezonestringThe time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
use_default_processor_featuresbooleanSpecifies whether the DB instance class of the DB instance uses its default processor features.<br/> This setting doesn't apply to RDS Custom DB instances.
use_latest_restorable_timebooleanSpecifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.<br/> Constraints:<br/> + Can't be specified if the ``RestoreTime`` parameter is provided.
v_pc_security_groupsarrayA 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.<br/> If you plan to update the resource, don't specify VPC security groups in a shared VPC.<br/> 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.<br/> 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:<br/> + You can't revert to using an RDS security group after you establish a VPC security group membership.<br/> + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_instance resource, the following permissions are required: + +### Read +
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+rds:DescribeDBInstances
+ +### Update +
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+iam:CreateServiceLinkedRole,
+iam:GetRole,
+iam:ListRoles,
+iam:PassRole,
+kms:CreateGrant,
+kms:DescribeKey,
+rds:AddRoleToDBInstance,
+rds:AddTagsToResource,
+rds:DescribeDBClusters,
+rds:DescribeDBEngineVersions,
+rds:DescribeDBInstances,
+rds:DescribeDBParameterGroups,
+rds:DescribeEvents,
+rds:ModifyDBInstance,
+rds:PromoteReadReplica,
+rds:RebootDBInstance,
+rds:RemoveRoleFromDBInstance,
+rds:RemoveTagsFromResource,
+rds:StartDBInstanceAutomatedBackupsReplication,
+rds:StopDBInstanceAutomatedBackupsReplication,
+secretsmanager:CreateSecret,
+secretsmanager:TagResource
+ +### Delete +
+rds:CreateDBSnapshot,
+rds:DeleteDBInstance,
+rds:DescribeDBInstances
+ + +## Example +```sql +SELECT +region, +allocated_storage, +allow_major_version_upgrade, +associated_roles, +auto_minor_version_upgrade, +automatic_backup_replication_region, +availability_zone, +backup_retention_period, +c_acertificate_identifier, +certificate_details, +certificate_rotation_restart, +character_set_name, +copy_tags_to_snapshot, +custom_ia_minstance_profile, +d_bcluster_identifier, +d_bcluster_snapshot_identifier, +d_binstance_arn, +d_binstance_class, +d_binstance_identifier, +dbi_resource_id, +d_bname, +d_bparameter_group_name, +d_bsecurity_groups, +d_bsnapshot_identifier, +d_bsubnet_group_name, +d_bsystem_id, +dedicated_log_volume, +delete_automated_backups, +deletion_protection, +domain, +domain_auth_secret_arn, +domain_dns_ips, +domain_fqdn, +domain_ia_mrole_name, +domain_ou, +enable_cloudwatch_logs_exports, +enable_ia_mdatabase_authentication, +enable_performance_insights, +endpoint, +engine, +engine_version, +manage_master_user_password, +iops, +kms_key_id, +license_model, +master_username, +master_user_password, +master_user_secret, +max_allocated_storage, +monitoring_interval, +monitoring_role_arn, +multi_az, +nchar_character_set_name, +network_type, +option_group_name, +performance_insights_km_skey_id, +performance_insights_retention_period, +port, +preferred_backup_window, +preferred_maintenance_window, +processor_features, +promotion_tier, +publicly_accessible, +replica_mode, +restore_time, +source_db_cluster_identifier, +source_dbi_resource_id, +source_db_instance_automated_backups_arn, +source_db_instance_identifier, +source_region, +storage_encrypted, +storage_type, +storage_throughput, +tags, +tde_credential_arn, +tde_credential_password, +timezone, +use_default_processor_features, +use_latest_restorable_time, +v_pc_security_groups +FROM awscc.rds.db_instance +WHERE region = 'us-east-1' +AND data__Identifier = '<DBInstanceIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_instances/index.md b/docs/awscc-docs/providers/awscc/rds/db_instances/index.md new file mode 100644 index 0000000000..4beadde7e5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_instances/index.md @@ -0,0 +1,87 @@ +--- +title: db_instances +hide_title: false +hide_table_of_contents: false +keywords: + - db_instances + - 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 +--- +Retrieves a list of db_instances in a region + +## Overview + + + + + +
Namedb_instances
TypeResource
Descriptiondb_instances
Idawscc.rds.db_instances
+ +## Fields + + + + + +
NameDatatypeDescription
d_binstance_identifierstringA 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).<br/> 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*.<br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_instances resource, the following permissions are required: + +### Create +
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcAttribute,
+ec2:DescribeVpcs,
+iam:CreateServiceLinkedRole,
+iam:GetRole,
+iam:ListRoles,
+iam:PassRole,
+kms:CreateGrant,
+kms:DescribeKey,
+rds:AddRoleToDBInstance,
+rds:AddTagsToResource,
+rds:CreateDBInstance,
+rds:CreateDBInstanceReadReplica,
+rds:DescribeDBInstances,
+rds:DescribeDBClusters,
+rds:DescribeDBClusterSnapshots,
+rds:DescribeDBInstanceAutomatedBackups,
+rds:DescribeDBSnapshots,
+rds:DescribeEvents,
+rds:ModifyDBInstance,
+rds:RebootDBInstance,
+rds:RestoreDBInstanceFromDBSnapshot,
+rds:RestoreDBInstanceToPointInTime,
+rds:StartDBInstanceAutomatedBackupsReplication,
+secretsmanager:CreateSecret,
+secretsmanager:TagResource
+ +### List +
+rds:DescribeDBInstances
+ + +## Example +```sql +SELECT +region, +d_binstance_identifier +FROM awscc.rds.db_instances +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_parameter_group/index.md b/docs/awscc-docs/providers/awscc/rds/db_parameter_group/index.md new file mode 100644 index 0000000000..f06c33f171 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_parameter_group/index.md @@ -0,0 +1,81 @@ +--- +title: db_parameter_group +hide_title: false +hide_table_of_contents: false +keywords: + - db_parameter_group + - 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 +--- +Gets an individual db_parameter_group resource + +## Overview + + + + + +
Namedb_parameter_group
TypeResource
Descriptiondb_parameter_group
Idawscc.rds.db_parameter_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
d_bparameter_group_namestringThe name of the DB parameter group.<br/> Constraints:<br/> + Must be 1 to 255 letters, numbers, or hyphens.<br/> + First character must be a letter<br/> + Can't end with a hyphen or contain two consecutive hyphens<br/> <br/> If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.<br/> This value is stored as a lowercase string.
descriptionstringProvides the customer-specified description for this DB parameter group.
familystringThe 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.<br/> The DB parameter group family can't be changed when updating a DB parameter group.<br/> To list all of the available parameter group families, use the following command:<br/> ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``<br/> The output contains duplicates.<br/> For more information, see ``CreateDBParameterGroup``.
parametersobjectAn array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.<br/> 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.<br/> 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*.<br/> 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*.<br/> AWS CloudFormation doesn't support specifying an apply method for each individual
tagsarrayAn optional array of key-value pairs to apply to this DB parameter group.<br/> Currently, this is the only property that supports drift detection.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_parameter_group resource, the following permissions are required: + +### Read +
+rds:DescribeDBParameterGroups,
+rds:DescribeDBParameters,
+rds:DescribeEngineDefaultParameters,
+rds:ListTagsForResource
+ +### Update +
+rds:AddTagsToResource,
+rds:DescribeDBParameterGroups,
+rds:DescribeDBParameters,
+rds:DescribeEngineDefaultParameters,
+rds:ListTagsForResource,
+rds:ModifyDBParameterGroup,
+rds:ResetDBParameterGroup,
+rds:RemoveTagsFromResource
+ +### Delete +
+rds:DeleteDBParameterGroup
+ + +## Example +```sql +SELECT +region, +d_bparameter_group_name, +description, +family, +parameters, +tags +FROM awscc.rds.db_parameter_group +WHERE region = 'us-east-1' +AND data__Identifier = '<DBParameterGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_parameter_groups/index.md b/docs/awscc-docs/providers/awscc/rds/db_parameter_groups/index.md new file mode 100644 index 0000000000..0f22fda678 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_parameter_groups/index.md @@ -0,0 +1,66 @@ +--- +title: db_parameter_groups +hide_title: false +hide_table_of_contents: false +keywords: + - db_parameter_groups + - 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 +--- +Retrieves a list of db_parameter_groups in a region + +## Overview + + + + + +
Namedb_parameter_groups
TypeResource
Descriptiondb_parameter_groups
Idawscc.rds.db_parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
d_bparameter_group_namestringThe name of the DB parameter group.<br/> Constraints:<br/> + Must be 1 to 255 letters, numbers, or hyphens.<br/> + First character must be a letter<br/> + Can't end with a hyphen or contain two consecutive hyphens<br/> <br/> If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.<br/> This value is stored as a lowercase string.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_parameter_groups resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+rds:AddTagsToResource,
+rds:CreateDBParameterGroup,
+rds:DescribeDBParameterGroups,
+rds:DescribeDBParameters,
+rds:DescribeEngineDefaultParameters,
+rds:ListTagsForResource,
+rds:ModifyDBParameterGroup,
+rds:RemoveTagsFromResource
+ +### List +
+rds:DescribeDBParameterGroups
+ + +## Example +```sql +SELECT +region, +d_bparameter_group_name +FROM awscc.rds.db_parameter_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxies/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxies/index.md new file mode 100644 index 0000000000..d2ebd590c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_proxies/index.md @@ -0,0 +1,60 @@ +--- +title: db_proxies +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxies + - 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 +--- +Retrieves a list of db_proxies in a region + +## Overview + + + + + +
Namedb_proxies
TypeResource
Descriptiondb_proxies
Idawscc.rds.db_proxies
+ +## Fields + + + + + +
NameDatatypeDescription
d_bproxy_namestringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_proxies resource, the following permissions are required: + +### Create +
+rds:CreateDBProxy,
+rds:DescribeDBProxies,
+iam:PassRole
+ +### List +
+rds:DescribeDBProxies
+ + +## Example +```sql +SELECT +region, +d_bproxy_name +FROM awscc.rds.db_proxies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxy/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxy/index.md new file mode 100644 index 0000000000..8d8e3d24ee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_proxy/index.md @@ -0,0 +1,91 @@ +--- +title: db_proxy +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy + - 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 +--- +Gets an individual db_proxy resource + +## Overview + + + + + +
Namedb_proxy
TypeResource
Descriptiondb_proxy
Idawscc.rds.db_proxy
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
autharrayThe authorization mechanism that the proxy uses.
d_bproxy_arnstringThe Amazon Resource Name (ARN) for the proxy.
d_bproxy_namestringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
debug_loggingbooleanWhether the proxy includes detailed information about SQL statements in its logs.
endpointstringThe endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
engine_familystringThe kinds of databases that the proxy can connect to.
idle_client_timeoutintegerThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
require_tl_sbooleanA Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
tagsarrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpc_idstringVPC ID to associate with the new DB proxy.
vpc_security_group_idsarrayVPC security group IDs to associate with the new proxy.
vpc_subnet_idsarrayVPC subnet IDs to associate with the new proxy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_proxy resource, the following permissions are required: + +### Read +
+rds:DescribeDBProxies
+ +### Update +
+rds:ModifyDBProxy,
+rds:AddTagsToResource,
+rds:RemoveTagsFromResource,
+iam:PassRole
+ +### Delete +
+rds:DescribeDBProxies,
+rds:DeleteDBProxy
+ + +## Example +```sql +SELECT +region, +auth, +d_bproxy_arn, +d_bproxy_name, +debug_logging, +endpoint, +engine_family, +idle_client_timeout, +require_tl_s, +role_arn, +tags, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids +FROM awscc.rds.db_proxy +WHERE region = 'us-east-1' +AND data__Identifier = '<DBProxyName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoint/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoint/index.md new file mode 100644 index 0000000000..839b72a76e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoint/index.md @@ -0,0 +1,85 @@ +--- +title: db_proxy_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_endpoint + - 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 +--- +Gets an individual db_proxy_endpoint resource + +## Overview + + + + + +
Namedb_proxy_endpoint
TypeResource
Descriptiondb_proxy_endpoint
Idawscc.rds.db_proxy_endpoint
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
d_bproxy_endpoint_namestringThe 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.
d_bproxy_endpoint_arnstringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
d_bproxy_namestringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
vpc_idstringVPC ID to associate with the new DB proxy endpoint.
vpc_security_group_idsarrayVPC security group IDs to associate with the new DB proxy endpoint.
vpc_subnet_idsarrayVPC subnet IDs to associate with the new DB proxy endpoint.
endpointstringThe 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.
target_rolestringA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
is_defaultbooleanA 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.
tagsarrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_proxy_endpoint resource, the following permissions are required: + +### Read +
+rds:DescribeDBProxyEndpoints,
+rds:ListTagsForResource
+ +### Update +
+rds:ModifyDBProxyEndpoint,
+rds:AddTagsToResource,
+rds:RemoveTagsFromResource
+ +### Delete +
+rds:DescribeDBProxyEndpoints,
+rds:DeleteDBProxyEndpoint
+ + +## Example +```sql +SELECT +region, +d_bproxy_endpoint_name, +d_bproxy_endpoint_arn, +d_bproxy_name, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +endpoint, +target_role, +is_default, +tags +FROM awscc.rds.db_proxy_endpoint +WHERE region = 'us-east-1' +AND data__Identifier = '<DBProxyEndpointName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoints/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoints/index.md new file mode 100644 index 0000000000..4f4f6287c5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoints/index.md @@ -0,0 +1,59 @@ +--- +title: db_proxy_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_endpoints + - 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 +--- +Retrieves a list of db_proxy_endpoints in a region + +## Overview + + + + + +
Namedb_proxy_endpoints
TypeResource
Descriptiondb_proxy_endpoints
Idawscc.rds.db_proxy_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
d_bproxy_endpoint_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_proxy_endpoints resource, the following permissions are required: + +### Create +
+rds:CreateDBProxyEndpoint,
+rds:DescribeDBProxyEndpoints
+ +### List +
+rds:DescribeDBProxyEndpoints
+ + +## Example +```sql +SELECT +region, +d_bproxy_endpoint_name +FROM awscc.rds.db_proxy_endpoints +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxy_target_group/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxy_target_group/index.md new file mode 100644 index 0000000000..601946a57a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_proxy_target_group/index.md @@ -0,0 +1,77 @@ +--- +title: db_proxy_target_group +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_target_group + - 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 +--- +Gets an individual db_proxy_target_group resource + +## Overview + + + + + +
Namedb_proxy_target_group
TypeResource
Descriptiondb_proxy_target_group
Idawscc.rds.db_proxy_target_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
d_bproxy_namestringThe identifier for the proxy.
target_group_arnstringThe Amazon Resource Name (ARN) representing the target group.
target_group_namestringThe identifier for the DBProxyTargetGroup
connection_pool_configuration_infoobject
d_binstance_identifiersarray
d_bcluster_identifiersarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_proxy_target_group resource, the following permissions are required: + +### Read +
+rds:DescribeDBProxyTargetGroups,
+rds:DescribeDBProxyTargets
+ +### Update +
+rds:DescribeDBProxyTargetGroups,
+rds:ModifyDBProxyTargetGroup,
+rds:RegisterDBProxyTargets,
+rds:DeregisterDBProxyTargets
+ +### Delete +
+rds:DeregisterDBProxyTargets
+ + +## Example +```sql +SELECT +region, +d_bproxy_name, +target_group_arn, +target_group_name, +connection_pool_configuration_info, +d_binstance_identifiers, +d_bcluster_identifiers +FROM awscc.rds.db_proxy_target_group +WHERE region = 'us-east-1' +AND data__Identifier = '<TargetGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxy_target_groups/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxy_target_groups/index.md new file mode 100644 index 0000000000..664d299217 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_proxy_target_groups/index.md @@ -0,0 +1,61 @@ +--- +title: db_proxy_target_groups +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_target_groups + - 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 +--- +Retrieves a list of db_proxy_target_groups in a region + +## Overview + + + + + +
Namedb_proxy_target_groups
TypeResource
Descriptiondb_proxy_target_groups
Idawscc.rds.db_proxy_target_groups
+ +## Fields + + + + + +
NameDatatypeDescription
target_group_arnstringThe Amazon Resource Name (ARN) representing the target group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_proxy_target_groups resource, the following permissions are required: + +### Create +
+rds:DescribeDBProxies,
+rds:DescribeDBProxyTargetGroups,
+rds:ModifyDBProxyTargetGroup,
+rds:RegisterDBProxyTargets
+ +### List +
+rds:DescribeDBProxyTargetGroups
+ + +## Example +```sql +SELECT +region, +target_group_arn +FROM awscc.rds.db_proxy_target_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_subnet_group/index.md b/docs/awscc-docs/providers/awscc/rds/db_subnet_group/index.md new file mode 100644 index 0000000000..20217631c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_subnet_group/index.md @@ -0,0 +1,76 @@ +--- +title: db_subnet_group +hide_title: false +hide_table_of_contents: false +keywords: + - db_subnet_group + - 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 +--- +Gets an individual db_subnet_group resource + +## Overview + + + + + +
Namedb_subnet_group
TypeResource
Descriptiondb_subnet_group
Idawscc.rds.db_subnet_group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
d_bsubnet_group_descriptionstringThe description for the DB subnet group.
d_bsubnet_group_namestringThe name for the DB subnet group. This value is stored as a lowercase string.<br/> Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".<br/> Example: ``mysubnetgroup``
subnet_idsarrayThe EC2 Subnet IDs for the DB subnet group.
tagsarrayAn optional array of key-value pairs to apply to this DB subnet group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_subnet_group resource, the following permissions are required: + +### Read +
+rds:DescribeDBSubnetGroups,
+rds:ListTagsForResource
+ +### Update +
+rds:ModifyDBSubnetGroup,
+rds:DescribeDBSubnetGroups,
+rds:AddTagsToResource,
+rds:RemoveTagsFromResource,
+rds:ListTagsForResource
+ +### Delete +
+rds:DeleteDBSubnetGroup,
+rds:DescribeDBSubnetGroups,
+rds:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +d_bsubnet_group_description, +d_bsubnet_group_name, +subnet_ids, +tags +FROM awscc.rds.db_subnet_group +WHERE region = 'us-east-1' +AND data__Identifier = '<DBSubnetGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/db_subnet_groups/index.md b/docs/awscc-docs/providers/awscc/rds/db_subnet_groups/index.md new file mode 100644 index 0000000000..14ef084415 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/db_subnet_groups/index.md @@ -0,0 +1,63 @@ +--- +title: db_subnet_groups +hide_title: false +hide_table_of_contents: false +keywords: + - db_subnet_groups + - 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 +--- +Retrieves a list of db_subnet_groups in a region + +## Overview + + + + + +
Namedb_subnet_groups
TypeResource
Descriptiondb_subnet_groups
Idawscc.rds.db_subnet_groups
+ +## Fields + + + + + +
NameDatatypeDescription
d_bsubnet_group_namestringThe name for the DB subnet group. This value is stored as a lowercase string.<br/> Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".<br/> Example: ``mysubnetgroup``
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the db_subnet_groups resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+rds:CreateDBSubnetGroup,
+rds:DescribeDBSubnetGroups,
+rds:AddTagsToResource,
+rds:RemoveTagsFromResource,
+rds:ListTagsForResource
+ +### List +
+rds:DescribeDBSubnetGroups
+ + +## Example +```sql +SELECT +region, +d_bsubnet_group_name +FROM awscc.rds.db_subnet_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/event_subscription/index.md b/docs/awscc-docs/providers/awscc/rds/event_subscription/index.md new file mode 100644 index 0000000000..d80d146719 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/event_subscription/index.md @@ -0,0 +1,83 @@ +--- +title: event_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscription + - 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 +--- +Gets an individual event_subscription resource + +## Overview + + + + + +
Nameevent_subscription
TypeResource
Descriptionevent_subscription
Idawscc.rds.event_subscription
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
subscription_namestringThe name of the subscription.
enabledbooleanA Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
event_categoriesarrayA 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.
sns_topic_arnstringThe 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.
source_idsarrayThe 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.
source_typestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_subscription resource, the following permissions are required: + +### Read +
+rds:DescribeEventSubscriptions,
+rds:ListTagsForResource
+ +### Update +
+rds:ModifyEventSubscription,
+rds:AddSourceIdentifierToSubscription,
+rds:RemoveSourceIdentifierFromSubscription,
+rds:DescribeEventSubscriptions,
+rds:ListTagsForResource,
+rds:AddTagsToResource,
+rds:RemoveTagsFromResource
+ +### Delete +
+rds:DeleteEventSubscription,
+rds:DescribeEventSubscriptions
+ + +## Example +```sql +SELECT +region, +tags, +subscription_name, +enabled, +event_categories, +sns_topic_arn, +source_ids, +source_type +FROM awscc.rds.event_subscription +WHERE region = 'us-east-1' +AND data__Identifier = '<SubscriptionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md b/docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md new file mode 100644 index 0000000000..6bf64c81d5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md @@ -0,0 +1,63 @@ +--- +title: event_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscriptions + - 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 +--- +Retrieves a list of event_subscriptions in a region + +## Overview + + + + + +
Nameevent_subscriptions
TypeResource
Descriptionevent_subscriptions
Idawscc.rds.event_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
subscription_namestringThe name of the subscription.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_subscriptions resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+rds:CreateEventSubscription,
+rds:DescribeEventSubscriptions,
+rds:ListTagsForResource,
+rds:AddTagsToResource,
+rds:RemoveTagsFromResource
+ +### List +
+rds:DescribeEventSubscriptions
+ + +## Example +```sql +SELECT +region, +subscription_name +FROM awscc.rds.event_subscriptions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/global_cluster/index.md b/docs/awscc-docs/providers/awscc/rds/global_cluster/index.md new file mode 100644 index 0000000000..898dd6001a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/global_cluster/index.md @@ -0,0 +1,77 @@ +--- +title: global_cluster +hide_title: false +hide_table_of_contents: false +keywords: + - global_cluster + - 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 +--- +Gets an individual global_cluster resource + +## Overview + + + + + +
Nameglobal_cluster
TypeResource
Descriptionglobal_cluster
Idawscc.rds.global_cluster
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
enginestringThe 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).<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
engine_versionstringThe 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.
deletion_protectionbooleanThe deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
global_cluster_identifierstringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
source_db_cluster_identifierstringThe 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.
storage_encryptedboolean The storage encryption setting for the new global database cluster.<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_cluster resource, the following permissions are required: + +### Read +
+rds:DescribeGlobalClusters
+ +### Update +
+rds:ModifyGlobalCluster,
+rds:DescribeGlobalClusters
+ +### Delete +
+rds:DescribeGlobalClusters,
+rds:DeleteGlobalCluster,
+rds:RemoveFromGlobalCluster,
+rds:DescribeDBClusters
+ + +## Example +```sql +SELECT +region, +engine, +engine_version, +deletion_protection, +global_cluster_identifier, +source_db_cluster_identifier, +storage_encrypted +FROM awscc.rds.global_cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<GlobalClusterIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/global_clusters/index.md b/docs/awscc-docs/providers/awscc/rds/global_clusters/index.md new file mode 100644 index 0000000000..b21fc0d06d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/global_clusters/index.md @@ -0,0 +1,60 @@ +--- +title: global_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - global_clusters + - 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 +--- +Retrieves a list of global_clusters in a region + +## Overview + + + + + +
Nameglobal_clusters
TypeResource
Descriptionglobal_clusters
Idawscc.rds.global_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
global_cluster_identifierstringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the global_clusters resource, the following permissions are required: + +### Create +
+rds:CreateGlobalCluster,
+rds:DescribeDBClusters,
+rds:DescribeGlobalClusters
+ +### List +
+rds:DescribeGlobalClusters
+ + +## Example +```sql +SELECT +region, +global_cluster_identifier +FROM awscc.rds.global_clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/index.md b/docs/awscc-docs/providers/awscc/rds/index.md new file mode 100644 index 0000000000..3455945033 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/index.md @@ -0,0 +1,63 @@ +--- +title: rds +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The rds service documentation. + +:::info Service Summary + +
+
+total resources: 26
+total selectable resources: 26
+total methods: 26
+
+
+ +::: + +## Resources +
+
+customdb_engine_version
+customdb_engine_versions
+db_cluster
+db_cluster_parameter_group
+db_cluster_parameter_groups
+db_clusters
+db_instance
+db_instances
+db_parameter_group
+db_parameter_groups
+db_proxies
+db_proxy
+db_proxy_endpoint +
+
+db_proxy_endpoints
+db_proxy_target_group
+db_proxy_target_groups
+db_subnet_group
+db_subnet_groups
+event_subscription
+event_subscriptions
+global_cluster
+global_clusters
+integration
+integrations
+option_group
+option_groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/rds/integration/index.md b/docs/awscc-docs/providers/awscc/rds/integration/index.md new file mode 100644 index 0000000000..8de3e72867 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/integration/index.md @@ -0,0 +1,80 @@ +--- +title: integration +hide_title: false +hide_table_of_contents: false +keywords: + - integration + - 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 +--- +Gets an individual integration resource + +## Overview + + + + + +
Nameintegration
TypeResource
Descriptionintegration
Idawscc.rds.integration
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
integration_namestringThe name of the integration.
tagsarrayAn array of key-value pairs to apply to this resource.
source_arnstringThe Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.
target_arnstringThe ARN of the Redshift data warehouse to use as the target for replication.
integration_arnstringThe ARN of the integration.
k_ms_key_idstringAn 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.
additional_encryption_contextobject
create_timestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integration resource, the following permissions are required: + +### Read +
+rds:DescribeIntegrations
+ +### Update +
+rds:DescribeIntegrations,
+rds:AddTagsToResource,
+rds:RemoveTagsFromResource
+ +### Delete +
+rds:DeleteIntegration,
+rds:DescribeIntegrations
+ + +## Example +```sql +SELECT +region, +integration_name, +tags, +source_arn, +target_arn, +integration_arn, +k_ms_key_id, +additional_encryption_context, +create_time +FROM awscc.rds.integration +WHERE region = 'us-east-1' +AND data__Identifier = '<IntegrationArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/integrations/index.md b/docs/awscc-docs/providers/awscc/rds/integrations/index.md new file mode 100644 index 0000000000..aeced69000 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/integrations/index.md @@ -0,0 +1,63 @@ +--- +title: integrations +hide_title: false +hide_table_of_contents: false +keywords: + - integrations + - 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 +--- +Retrieves a list of integrations in a region + +## Overview + + + + + +
Nameintegrations
TypeResource
Descriptionintegrations
Idawscc.rds.integrations
+ +## Fields + + + + + +
NameDatatypeDescription
integration_arnstringThe ARN of the integration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the integrations resource, the following permissions are required: + +### Create +
+rds:CreateIntegration,
+rds:DescribeIntegrations,
+rds:AddTagsToResource,
+kms:CreateGrant,
+kms:DescribeKey,
+redshift:CreateInboundIntegration
+ +### List +
+rds:DescribeIntegrations
+ + +## Example +```sql +SELECT +region, +integration_arn +FROM awscc.rds.integrations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/option_group/index.md b/docs/awscc-docs/providers/awscc/rds/option_group/index.md new file mode 100644 index 0000000000..5f74e710d8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/option_group/index.md @@ -0,0 +1,81 @@ +--- +title: option_group +hide_title: false +hide_table_of_contents: false +keywords: + - option_group + - 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 +--- +Gets an individual option_group resource + +## Overview + + + + + +
Nameoption_group
TypeResource
Descriptionoption_group
Idawscc.rds.option_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
option_group_namestringSpecifies the name of the option group.
option_group_descriptionstringProvides a description of the option group.
engine_namestringIndicates the name of the engine that this option group can be applied to.
major_engine_versionstringIndicates the major engine version associated with this option group.
option_configurationsarrayIndicates what options are available in the option group.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the option_group resource, the following permissions are required: + +### Read +
+rds:DescribeOptionGroups,
+rds:ListTagsForResource
+ +### Update +
+rds:AddTagsToResource,
+rds:DescribeOptionGroups,
+rds:ListTagsForResource,
+rds:ModifyOptionGroup,
+rds:RemoveTagsFromResource
+ +### Delete +
+rds:DeleteOptionGroup,
+rds:DescribeOptionGroups,
+rds:ListTagsForResource,
+rds:RemoveTagsFromResource
+ + +## Example +```sql +SELECT +region, +option_group_name, +option_group_description, +engine_name, +major_engine_version, +option_configurations, +tags +FROM awscc.rds.option_group +WHERE region = 'us-east-1' +AND data__Identifier = '<OptionGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rds/option_groups/index.md b/docs/awscc-docs/providers/awscc/rds/option_groups/index.md new file mode 100644 index 0000000000..6beb2fa54e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rds/option_groups/index.md @@ -0,0 +1,64 @@ +--- +title: option_groups +hide_title: false +hide_table_of_contents: false +keywords: + - option_groups + - 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 +--- +Retrieves a list of option_groups in a region + +## Overview + + + + + +
Nameoption_groups
TypeResource
Descriptionoption_groups
Idawscc.rds.option_groups
+ +## Fields + + + + + +
NameDatatypeDescription
option_group_namestringSpecifies the name of the option group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the option_groups resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+rds:AddTagsToResource,
+rds:CreateOptionGroup,
+rds:DescribeOptionGroups,
+rds:ListTagsForResource,
+rds:ModifyOptionGroup,
+rds:RemoveTagsFromResource
+ +### List +
+rds:DescribeOptionGroups
+ + +## Example +```sql +SELECT +region, +option_group_name +FROM awscc.rds.option_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/cluster/index.md b/docs/awscc-docs/providers/awscc/redshift/cluster/index.md new file mode 100644 index 0000000000..2693cb8f6f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/cluster/index.md @@ -0,0 +1,204 @@ +--- +title: cluster +hide_title: false +hide_table_of_contents: false +keywords: + - cluster + - 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 +--- +Gets an individual cluster resource + +## Overview + + + + + +
Namecluster
TypeResource
Descriptioncluster
Idawscc.redshift.cluster
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_identifierstringA 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
cluster_namespace_arnstringThe Amazon Resource Name (ARN) of the cluster namespace.
master_usernamestringThe 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.
master_user_passwordstringThe 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.
node_typestringThe 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
allow_version_upgradebooleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
automated_snapshot_retention_periodintegerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
availability_zonestringThe 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
cluster_parameter_group_namestringThe name of the parameter group to be associated with this cluster.
cluster_typestringThe 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
cluster_versionstringThe 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.
cluster_subnet_group_namestringThe name of a cluster subnet group to be associated with this cluster.
d_bnamestringThe 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.
elastic_ipstringThe Elastic IP (EIP) address for the cluster.
encryptedbooleanIf true, the data in the cluster is encrypted at rest.
hsm_client_certificate_identifierstringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
hsm_configuration_identifierstringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
kms_key_idstringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
number_of_nodesintegerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
portintegerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
preferred_maintenance_windowstringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
publicly_accessiblebooleanIf true, the cluster can be accessed from a public network.
cluster_security_groupsarrayA list of security groups to be associated with this cluster.
iam_rolesarrayA 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
tagsarrayThe list of tags for the cluster parameter group.
vpc_security_group_idsarrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
snapshot_cluster_identifierstringThe 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.
snapshot_identifierstringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
owner_accountstring
logging_propertiesobject
endpointobject
destination_regionstringThe 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
snapshot_copy_retention_periodintegerThe number of days to retain automated snapshots in the destination region after they are copied from the source region. <br/><br/> Default is 7. <br/><br/> Constraints: Must be at least 1 and no more than 35.
snapshot_copy_grant_namestringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
manual_snapshot_retention_periodintegerThe 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.<br/><br/>The value must be either -1 or an integer between 1 and 3,653.
snapshot_copy_manualbooleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
availability_zone_relocationbooleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
availability_zone_relocation_statusstringThe availability zone relocation status of the cluster
aqua_configuration_statusstringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.<br/><br/>enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.<br/>disabled - Don't use AQUA.<br/>auto - Amazon Redshift determines whether to use AQUA.<br/>
classicbooleanA 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.
enhanced_vpc_routingbooleanAn 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.<br/><br/>If this option is true , enhanced VPC routing is enabled.<br/><br/>Default: false
maintenance_track_namestringThe 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.
defer_maintenancebooleanA boolean indicating whether to enable the deferred maintenance window.
defer_maintenance_identifierstringA unique identifier for the deferred maintenance window.
defer_maintenance_start_timestringA timestamp indicating the start time for the deferred maintenance window.
defer_maintenance_end_timestringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
defer_maintenance_durationintegerAn 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.
revision_targetstringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
resource_actionstringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
rotate_encryption_keybooleanA boolean indicating if we want to rotate Encryption Keys.
multi_azbooleanA 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.
namespace_resource_policyobjectThe namespace resource policy document that will be attached to a Redshift cluster.
manage_master_passwordbooleanA 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.
master_password_secret_kms_key_idstringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
master_password_secret_arnstringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +
+redshift:DescribeClusters,
+redshift:DescribeLoggingStatus,
+redshift:DescribeSnapshotCopyGrant,
+redshift:DescribeClusterDbRevisions,
+redshift:DescribeTags,
+redshift:GetResourcePolicy
+ +### Update +
+iam:PassRole,
+redshift:DescribeClusters,
+redshift:ModifyCluster,
+redshift:ModifyClusterIamRoles,
+redshift:EnableLogging,
+redshift:CreateTags,
+redshift:DeleteTags,
+redshift:DescribeTags,
+redshift:DisableLogging,
+redshift:DescribeLoggingStatus,
+redshift:RebootCluster,
+redshift:EnableSnapshotCopy,
+redshift:DisableSnapshotCopy,
+redshift:ModifySnapshotCopyRetentionPeriod,
+redshift:ModifyAquaConfiguration,
+redshift:ResizeCluster,
+redshift:ModifyClusterMaintenance,
+redshift:DescribeClusterDbRevisions,
+redshift:ModifyClusterDbRevisions,
+redshift:PauseCluster,
+redshift:ResumeCluster,
+redshift:RotateEncryptionKey,
+redshift:FailoverPrimaryCompute,
+redshift:PutResourcePolicy,
+redshift:GetResourcePolicy,
+redshift:DeleteResourcePolicy,
+cloudwatch:PutMetricData
+ +### Delete +
+redshift:DescribeTags,
+redshift:DescribeClusters,
+redshift:DeleteCluster
+ + +## Example +```sql +SELECT +region, +cluster_identifier, +cluster_namespace_arn, +master_username, +master_user_password, +node_type, +allow_version_upgrade, +automated_snapshot_retention_period, +availability_zone, +cluster_parameter_group_name, +cluster_type, +cluster_version, +cluster_subnet_group_name, +d_bname, +elastic_ip, +encrypted, +hsm_client_certificate_identifier, +hsm_configuration_identifier, +kms_key_id, +number_of_nodes, +port, +preferred_maintenance_window, +publicly_accessible, +cluster_security_groups, +iam_roles, +tags, +vpc_security_group_ids, +snapshot_cluster_identifier, +snapshot_identifier, +owner_account, +logging_properties, +endpoint, +destination_region, +snapshot_copy_retention_period, +snapshot_copy_grant_name, +manual_snapshot_retention_period, +snapshot_copy_manual, +availability_zone_relocation, +availability_zone_relocation_status, +aqua_configuration_status, +classic, +enhanced_vpc_routing, +maintenance_track_name, +defer_maintenance, +defer_maintenance_identifier, +defer_maintenance_start_time, +defer_maintenance_end_time, +defer_maintenance_duration, +revision_target, +resource_action, +rotate_encryption_key, +multi_az, +namespace_resource_policy, +manage_master_password, +master_password_secret_kms_key_id, +master_password_secret_arn +FROM awscc.redshift.cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_group/index.md b/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_group/index.md new file mode 100644 index 0000000000..6f4ad0504b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_group/index.md @@ -0,0 +1,85 @@ +--- +title: cluster_parameter_group +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_parameter_group + - 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 +--- +Gets an individual cluster_parameter_group resource + +## Overview + + + + + +
Namecluster_parameter_group
TypeResource
Descriptioncluster_parameter_group
Idawscc.redshift.cluster_parameter_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the cluster parameter group.
descriptionstringA description of the parameter group.
parameter_group_familystringThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
parametersarrayAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster_parameter_group resource, the following permissions are required: + +### Read +
+redshift:DescribeClusterParameterGroups,
+initech:DescribeReport,
+redshift:DescribeClusterParameters,
+redshift:DescribeTags
+ +### Update +
+redshift:DescribeClusterParameterGroups,
+redshift:ResetClusterParameterGroup,
+redshift:ModifyClusterParameterGroup,
+redshift:DescribeClusterParameters,
+redshift:DescribeTags,
+redshift:CreateTags,
+redshift:DeleteTags,
+initech:UpdateReport
+ +### Delete +
+redshift:DescribeTags,
+redshift:DescribeClusterParameterGroups,
+redshift:DeleteClusterParameterGroup,
+redshift:DescribeClusterParameters,
+initech:DeleteReport
+ + +## Example +```sql +SELECT +region, +parameter_group_name, +description, +parameter_group_family, +parameters, +tags +FROM awscc.redshift.cluster_parameter_group +WHERE region = 'us-east-1' +AND data__Identifier = '<ParameterGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_groups/index.md b/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_groups/index.md new file mode 100644 index 0000000000..0a1bc36f72 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_groups/index.md @@ -0,0 +1,76 @@ +--- +title: cluster_parameter_groups +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_parameter_groups + - 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 +--- +Retrieves a list of cluster_parameter_groups in a region + +## Overview + + + + + +
Namecluster_parameter_groups
TypeResource
Descriptioncluster_parameter_groups
Idawscc.redshift.cluster_parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the cluster parameter group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster_parameter_groups resource, the following permissions are required: + +### Create +
+redshift:CreateClusterParameterGroup,
+redshift:ModifyClusterParameterGroup,
+redshift:DescribeClusterParameterGroups,
+redshift:DescribeClusterParameters,
+redshift:DescribeTags,
+redshift:CreateTags,
+ec2:AllocateAddress,
+ec2:AssociateAddress,
+ec2:AttachNetworkInterface,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAddresses,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs
+ +### List +
+redshift:DescribeTags,
+redshift:DescribeClusterParameterGroups,
+redshift:DescribeClusterParameters,
+initech:ListReports
+ + +## Example +```sql +SELECT +region, +parameter_group_name +FROM awscc.redshift.cluster_parameter_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_group/index.md b/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_group/index.md new file mode 100644 index 0000000000..2576fb10a4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_group/index.md @@ -0,0 +1,106 @@ +--- +title: cluster_subnet_group +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_subnet_group + - 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 +--- +Gets an individual cluster_subnet_group resource + +## Overview + + + + + +
Namecluster_subnet_group
TypeResource
Descriptioncluster_subnet_group
Idawscc.redshift.cluster_subnet_group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the parameter group.
subnet_idsarrayThe list of VPC subnet IDs
tagsarrayThe list of tags for the cluster parameter group.
cluster_subnet_group_namestringThis 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".
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster_subnet_group resource, the following permissions are required: + +### Read +
+redshift:DescribeClusterSubnetGroups,
+redshift:DescribeTags,
+ec2:AllocateAddress,
+ec2:AssociateAddress,
+ec2:AttachNetworkInterface,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAddresses,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs
+ +### Update +
+redshift:ModifyClusterSubnetGroup,
+redshift:DescribeClusterSubnetGroups,
+redshift:DescribeTags,
+redshift:CreateTags,
+redshift:DeleteTags,
+ec2:AllocateAddress,
+ec2:AssociateAddress,
+ec2:AttachNetworkInterface,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAddresses,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs
+ +### Delete +
+redshift:DeleteClusterSubnetGroup,
+redshift:DescribeClusterSubnetGroups,
+redshift:DescribeTags,
+ec2:AllocateAddress,
+ec2:AssociateAddress,
+ec2:AttachNetworkInterface,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAddresses,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs
+ + +## Example +```sql +SELECT +region, +description, +subnet_ids, +tags, +cluster_subnet_group_name +FROM awscc.redshift.cluster_subnet_group +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterSubnetGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_groups/index.md b/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_groups/index.md new file mode 100644 index 0000000000..d197a04bf8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_groups/index.md @@ -0,0 +1,82 @@ +--- +title: cluster_subnet_groups +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_subnet_groups + - 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 +--- +Retrieves a list of cluster_subnet_groups in a region + +## Overview + + + + + +
Namecluster_subnet_groups
TypeResource
Descriptioncluster_subnet_groups
Idawscc.redshift.cluster_subnet_groups
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_subnet_group_namestringThis 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".
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster_subnet_groups resource, the following permissions are required: + +### Create +
+redshift:CreateClusterSubnetGroup,
+redshift:CreateTags,
+redshift:DescribeClusterSubnetGroups,
+redshift:DescribeTags,
+ec2:AllocateAddress,
+ec2:AssociateAddress,
+ec2:AttachNetworkInterface,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAddresses,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs
+ +### List +
+redshift:DescribeClusterSubnetGroups,
+redshift:DescribeTags,
+ec2:AllocateAddress,
+ec2:AssociateAddress,
+ec2:AttachNetworkInterface,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAddresses,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeVpcs
+ + +## Example +```sql +SELECT +region, +cluster_subnet_group_name +FROM awscc.redshift.cluster_subnet_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/clusters/index.md b/docs/awscc-docs/providers/awscc/redshift/clusters/index.md new file mode 100644 index 0000000000..c68a276555 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/clusters/index.md @@ -0,0 +1,90 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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 +--- +Retrieves a list of clusters in a region + +## Overview + + + + + +
Nameclusters
TypeResource
Descriptionclusters
Idawscc.redshift.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_identifierstringA 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
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+redshift:DescribeClusters,
+redshift:CreateCluster,
+redshift:RestoreFromClusterSnapshot,
+redshift:EnableLogging,
+redshift:DescribeLoggingStatus,
+redshift:CreateTags,
+redshift:DescribeTags,
+redshift:GetResourcePolicy,
+redshift:PutResourcePolicy,
+redshift:ModifyClusterMaintenance,
+ec2:DescribeVpcs,
+ec2:DescribeSubnets,
+ec2:DescribeNetworkInterfaces,
+ec2:DescribeAddresses,
+ec2:AssociateAddress,
+ec2:CreateNetworkInterface,
+ec2:ModifyNetworkInterfaceAttribute,
+ec2:CreateVpcEndpoint,
+ec2:DescribeVpcEndpoints,
+ec2:ModifyVpcEndpoint,
+ec2:AllocateAddress,
+ec2:CreateSecurityGroup,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeInternetGateways,
+ec2:DescribeSecurityGroupRules,
+ec2:DescribeAvailabilityZones,
+ec2:DescribeNetworkAcls,
+ec2:DescribeRouteTables,
+cloudwatch:PutMetricData
+ +### List +
+redshift:DescribeTags,
+redshift:DescribeClusters
+ + +## Example +```sql +SELECT +region, +cluster_identifier +FROM awscc.redshift.clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md new file mode 100644 index 0000000000..bf77f398ca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md @@ -0,0 +1,107 @@ +--- +title: endpoint_access +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_access + - 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 +--- +Gets an individual endpoint_access resource + +## Overview + + + + + +
Nameendpoint_access
TypeResource
Descriptionendpoint_access
Idawscc.redshift.endpoint_access
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
addressstringThe DNS address of the endpoint.
cluster_identifierstringA 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
vpc_security_groupsarrayA list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.
resource_ownerstringThe AWS account ID of the owner of the cluster.
endpoint_statusstringThe status of the endpoint.
endpoint_namestringThe name of the endpoint.
endpoint_create_timestringThe time (UTC) that the endpoint was created.
subnet_group_namestringThe subnet group name where Amazon Redshift chooses to deploy the endpoint.
portintegerThe port number on which the cluster accepts incoming connections.
vpc_security_group_idsarrayA list of vpc security group ids to apply to the created endpoint access.
vpc_endpointobjectThe connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint_access resource, the following permissions are required: + +### Read +
+redshift:DescribeEndpointAccess,
+ec2:DescribeClientVpnEndpoints,
+ec2:DescribeVpcEndpoint,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets
+ +### Update +
+redshift:DescribeEndpointAccess,
+redshift:ModifyEndpointAccess,
+ec2:ModifyClientVpnEndpoint,
+ec2:ModifyVpcEndpoint,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets
+ +### Delete +
+redshift:DeleteEndpointAccess,
+redshift:DescribeEndpointAccess,
+ec2:DeleteClientVpnEndpoint,
+ec2:DeleteVpcEndpoint,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets,
+ec2:DescribeVpcEndpoint
+ + +## Example +```sql +SELECT +region, +address, +cluster_identifier, +vpc_security_groups, +resource_owner, +endpoint_status, +endpoint_name, +endpoint_create_time, +subnet_group_name, +port, +vpc_security_group_ids, +vpc_endpoint +FROM awscc.redshift.endpoint_access +WHERE region = 'us-east-1' +AND data__Identifier = '<EndpointName>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md new file mode 100644 index 0000000000..87344efabc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md @@ -0,0 +1,73 @@ +--- +title: endpoint_accesses +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_accesses + - 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 +--- +Retrieves a list of endpoint_accesses in a region + +## Overview + + + + + +
Nameendpoint_accesses
TypeResource
Descriptionendpoint_accesses
Idawscc.redshift.endpoint_accesses
+ +## Fields + + + + + +
NameDatatypeDescription
endpoint_namestringThe name of the endpoint.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint_accesses resource, the following permissions are required: + +### Create +
+redshift:CreateEndpointAccess,
+redshift:DescribeEndpointAccess,
+ec2:CreateClientVpnEndpoint,
+ec2:CreateVpcEndpoint,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets
+ +### List +
+redshift:DescribeEndpointAccess,
+ec2:DescribeClientVpnEndpoints,
+ec2:DescribeVpcEndpoints,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets
+ + +## Example +```sql +SELECT +region, +endpoint_name +FROM awscc.redshift.endpoint_accesses +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md new file mode 100644 index 0000000000..617a3735bb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md @@ -0,0 +1,96 @@ +--- +title: endpoint_authorization +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_authorization + - 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 +--- +Gets an individual endpoint_authorization resource + +## Overview + + + + + +
Nameendpoint_authorization
TypeResource
Descriptionendpoint_authorization
Idawscc.redshift.endpoint_authorization
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
grantorstringThe AWS account ID of the cluster owner.
granteestringThe AWS account ID of the grantee of the cluster.
cluster_identifierstringThe cluster identifier.
authorize_timestringThe time (UTC) when the authorization was created.
cluster_statusstringThe status of the cluster.
statusstringThe status of the authorization action.
allowed_all_vp_csbooleanIndicates whether all VPCs in the grantee account are allowed access to the cluster.
allowed_vp_csarrayThe VPCs allowed access to the cluster.
endpoint_countintegerThe number of Redshift-managed VPC endpoints created for the authorization.
accountstringThe target AWS account ID to grant or revoke access for.
vpc_idsarrayThe virtual private cloud (VPC) identifiers to grant or revoke access to.
forceboolean Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint_authorization resource, the following permissions are required: + +### Read +
+redshift:DescribeEndpointAuthorization
+ +### Update +
+redshift:AuthorizeEndpointAccess,
+redshift:DescribeEndpointAuthorization,
+redshift:RevokeEndpointAccess
+ +### Delete +
+redshift:RevokeEndpointAccess,
+redshift:DeleteEndpointAccess,
+redshift:DescribeEndpointAuthorization,
+ec2:DeleteClientVpnEndpoint,
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets
+ + +## Example +```sql +SELECT +region, +grantor, +grantee, +cluster_identifier, +authorize_time, +cluster_status, +status, +allowed_all_vp_cs, +allowed_vp_cs, +endpoint_count, +account, +vpc_ids, +force +FROM awscc.redshift.endpoint_authorization +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterIdentifier>' +AND data__Identifier = '<Account>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md new file mode 100644 index 0000000000..c0abd06a19 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md @@ -0,0 +1,61 @@ +--- +title: endpoint_authorizations +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_authorizations + - 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 +--- +Retrieves a list of endpoint_authorizations in a region + +## Overview + + + + + +
Nameendpoint_authorizations
TypeResource
Descriptionendpoint_authorizations
Idawscc.redshift.endpoint_authorizations
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_identifierstringThe cluster identifier.
accountundefinedThe target AWS account ID to grant or revoke access for.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint_authorizations resource, the following permissions are required: + +### Create +
+redshift:AuthorizeEndpointAccess,
+redshift:DescribeEndpointAuthorization
+ +### List +
+redshift:DescribeEndpointAuthorization
+ + +## Example +```sql +SELECT +region, +cluster_identifier, +account +FROM awscc.redshift.endpoint_authorizations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md b/docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md new file mode 100644 index 0000000000..28a2a8a7af --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md @@ -0,0 +1,97 @@ +--- +title: event_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscription + - 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 +--- +Gets an individual event_subscription resource + +## Overview + + + + + +
Nameevent_subscription
TypeResource
Descriptionevent_subscription
Idawscc.redshift.event_subscription
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
subscription_namestringThe name of the Amazon Redshift event notification subscription
sns_topic_arnstringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
source_typestringThe type of source that will be generating the events.
source_idsarrayA list of one or more identifiers of Amazon Redshift source objects.
event_categoriesarraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
severitystringSpecifies the Amazon Redshift event severity to be published by the event notification subscription.
enabledbooleanA boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
tagsarrayAn array of key-value pairs to apply to this resource.
customer_aws_idstringThe AWS account associated with the Amazon Redshift event notification subscription.
cust_subscription_idstringThe name of the Amazon Redshift event notification subscription.
statusstringThe status of the Amazon Redshift event notification subscription.
subscription_creation_timestringThe date and time the Amazon Redshift event notification subscription was created.
source_ids_listarrayA list of the sources that publish events to the Amazon Redshift event notification subscription.
event_categories_listarrayThe list of Amazon Redshift event categories specified in the event notification subscription.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_subscription resource, the following permissions are required: + +### Read +
+redshift:DescribeEventSubscriptions,
+redshift:DescribeTags
+ +### Update +
+redshift:ModifyEventSubscription,
+redshift:CreateTags,
+redshift:DescribeTags,
+redshift:DescribeEventSubscriptions,
+redshift:DeleteTags
+ +### Delete +
+redshift:DescribeEventSubscriptions,
+redshift:DeleteEventSubscription,
+redshift:DescribeTags,
+redshift:DeleteTags
+ + +## Example +```sql +SELECT +region, +subscription_name, +sns_topic_arn, +source_type, +source_ids, +event_categories, +severity, +enabled, +tags, +customer_aws_id, +cust_subscription_id, +status, +subscription_creation_time, +source_ids_list, +event_categories_list +FROM awscc.redshift.event_subscription +WHERE region = 'us-east-1' +AND data__Identifier = '<SubscriptionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md b/docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md new file mode 100644 index 0000000000..7732b06d70 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md @@ -0,0 +1,62 @@ +--- +title: event_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscriptions + - 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 +--- +Retrieves a list of event_subscriptions in a region + +## Overview + + + + + +
Nameevent_subscriptions
TypeResource
Descriptionevent_subscriptions
Idawscc.redshift.event_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
subscription_namestringThe name of the Amazon Redshift event notification subscription
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the event_subscriptions resource, the following permissions are required: + +### Create +
+redshift:CreateEventSubscription,
+redshift:CreateTags,
+redshift:DescribeTags,
+redshift:DescribeEventSubscriptions
+ +### List +
+redshift:DescribeTags,
+redshift:DescribeEventSubscriptions
+ + +## Example +```sql +SELECT +region, +subscription_name +FROM awscc.redshift.event_subscriptions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/index.md b/docs/awscc-docs/providers/awscc/redshift/index.md new file mode 100644 index 0000000000..46cb6cc67d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/index.md @@ -0,0 +1,51 @@ +--- +title: redshift +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The redshift service documentation. + +:::info Service Summary + +
+
+total resources: 14
+total selectable resources: 14
+total methods: 14
+
+
+ +::: + +## Resources +
+
+cluster
+cluster_parameter_group
+cluster_parameter_groups
+cluster_subnet_group
+cluster_subnet_groups
+clusters
+endpoint_access +
+
+endpoint_accesses
+endpoint_authorization
+endpoint_authorizations
+event_subscription
+event_subscriptions
+scheduled_action
+scheduled_actions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/redshift/scheduled_action/index.md b/docs/awscc-docs/providers/awscc/redshift/scheduled_action/index.md new file mode 100644 index 0000000000..730c29674e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/scheduled_action/index.md @@ -0,0 +1,90 @@ +--- +title: scheduled_action +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_action + - 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 +--- +Gets an individual scheduled_action resource + +## Overview + + + + + +
Namescheduled_action
TypeResource
Descriptionscheduled_action
Idawscc.redshift.scheduled_action
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
scheduled_action_namestringThe name of the scheduled action. The name must be unique within an account.
target_actionobjectA JSON format string of the Amazon Redshift API operation with input parameters.
schedulestringThe schedule in `at( )` or `cron( )` format.
iam_rolestringThe IAM role to assume to run the target action.
scheduled_action_descriptionstringThe description of the scheduled action.
start_timestringThe start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
end_timestringThe end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
enablebooleanIf true, the schedule is enabled. If false, the scheduled action does not trigger.
statestringThe state of the scheduled action.
next_invocationsarrayList of times when the scheduled action will run.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_action resource, the following permissions are required: + +### Read +
+redshift:DescribeScheduledActions,
+redshift:DescribeTags
+ +### Update +
+redshift:DescribeScheduledActions,
+redshift:ModifyScheduledAction,
+redshift:PauseCluster,
+redshift:ResumeCluster,
+redshift:ResizeCluster,
+redshift:DescribeTags,
+iam:PassRole
+ +### Delete +
+redshift:DescribeTags,
+redshift:DescribeScheduledActions,
+redshift:DeleteScheduledAction
+ + +## Example +```sql +SELECT +region, +scheduled_action_name, +target_action, +schedule, +iam_role, +scheduled_action_description, +start_time, +end_time, +enable, +state, +next_invocations +FROM awscc.redshift.scheduled_action +WHERE region = 'us-east-1' +AND data__Identifier = '<ScheduledActionName>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md b/docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md new file mode 100644 index 0000000000..ea5685645e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md @@ -0,0 +1,65 @@ +--- +title: scheduled_actions +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_actions + - 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 +--- +Retrieves a list of scheduled_actions in a region + +## Overview + + + + + +
Namescheduled_actions
TypeResource
Descriptionscheduled_actions
Idawscc.redshift.scheduled_actions
+ +## Fields + + + + + +
NameDatatypeDescription
scheduled_action_namestringThe name of the scheduled action. The name must be unique within an account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_actions resource, the following permissions are required: + +### Create +
+redshift:CreateScheduledAction,
+redshift:DescribeScheduledActions,
+redshift:DescribeTags,
+redshift:PauseCluster,
+redshift:ResumeCluster,
+redshift:ResizeCluster,
+iam:PassRole
+ +### List +
+redshift:DescribeTags,
+redshift:DescribeScheduledActions
+ + +## Example +```sql +SELECT +region, +scheduled_action_name +FROM awscc.redshift.scheduled_actions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/index.md new file mode 100644 index 0000000000..ee37f76562 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshiftserverless/index.md @@ -0,0 +1,41 @@ +--- +title: redshiftserverless +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The redshiftserverless service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+namespace
+namespaces +
+
+workgroup
+workgroups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/namespace/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/namespace/index.md new file mode 100644 index 0000000000..9a93a064fc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshiftserverless/namespace/index.md @@ -0,0 +1,132 @@ +--- +title: namespace +hide_title: false +hide_table_of_contents: false +keywords: + - namespace + - 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 +--- +Gets an individual namespace resource + +## Overview + + + + + +
Namenamespace
TypeResource
Descriptionnamespace
Idawscc.redshiftserverless.namespace
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
admin_password_secret_kms_key_idstringThe 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.
admin_user_passwordstringThe 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.
admin_usernamestringThe 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.
db_namestringThe database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
default_iam_role_arnstringThe default IAM role ARN for the namespace that is being created.
iam_rolesarrayA 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.
kms_key_idstringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
log_exportsarrayThe 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
manage_admin_passwordbooleanIf 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.
namespaceobjectDefinition of Namespace resource.
namespace_namestringA 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.
tagsarrayThe list of tags for the namespace.
final_snapshot_namestringThe name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace
final_snapshot_retention_periodintegerThe 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.
namespace_resource_policyobjectThe resource policy document that will be attached to the namespace.
redshift_idc_application_arnstringThe ARN for the Redshift application that integrates with IAM Identity Center.
snapshot_copy_configurationsarrayThe snapshot copy configurations for the namespace.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the namespace resource, the following permissions are required: + +### Read +
+iam:PassRole,
+redshift-serverless:GetNamespace,
+redshift:GetResourcePolicy,
+redshift-serverless:ListSnapshotCopyConfigurations
+ +### Update +
+iam:PassRole,
+kms:TagResource,
+kms:UntagResource,
+kms:ScheduleKeyDeletion,
+kms:CancelKeyDeletion,
+kms:Encrypt,
+kms:Decrypt,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:ListGrants,
+kms:RevokeGrant,
+kms:RetireGrant,
+kms:GenerateDataKeyPair,
+kms:GenerateDataKey,
+redshift-serverless:UpdateNamespace,
+redshift-serverless:GetNamespace,
+redshift-serverless:ListSnapshotCopyConfigurations,
+redshift-serverless:CreateSnapshotCopyConfiguration,
+redshift-serverless:UpdateSnapshotCopyConfiguration,
+redshift-serverless:DeleteSnapshotCopyConfiguration,
+redshift:GetResourcePolicy,
+redshift:PutResourcePolicy,
+redshift:DeleteResourcePolicy,
+secretsmanager:CreateSecret,
+secretsmanager:TagResource,
+secretsmanager:RotateSecret,
+secretsmanager:DescribeSecret,
+secretsmanager:UpdateSecret,
+secretsmanager:DeleteSecret
+ +### Delete +
+iam:PassRole,
+redshift-serverless:DeleteNamespace,
+redshift-serverless:GetNamespace,
+kms:RetireGrant,
+secretsmanager:DescribeSecret,
+secretsmanager:DeleteSecret,
+redshift:DeleteResourcePolicy
+ + +## Example +```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, +tags, +final_snapshot_name, +final_snapshot_retention_period, +namespace_resource_policy, +redshift_idc_application_arn, +snapshot_copy_configurations +FROM awscc.redshiftserverless.namespace +WHERE region = 'us-east-1' +AND data__Identifier = '<NamespaceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md new file mode 100644 index 0000000000..6df06411ec --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md @@ -0,0 +1,82 @@ +--- +title: namespaces +hide_title: false +hide_table_of_contents: false +keywords: + - namespaces + - 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 +--- +Retrieves a list of namespaces in a region + +## Overview + + + + + +
Namenamespaces
TypeResource
Descriptionnamespaces
Idawscc.redshiftserverless.namespaces
+ +## Fields + + + + + +
NameDatatypeDescription
namespace_namestringA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the namespaces resource, the following permissions are required: + +### Create +
+iam:PassRole,
+kms:TagResource,
+kms:UntagResource,
+kms:ScheduleKeyDeletion,
+kms:CancelKeyDeletion,
+kms:Encrypt,
+kms:Decrypt,
+kms:DescribeKey,
+kms:GenerateDataKeyPair,
+kms:GenerateDataKey,
+kms:CreateGrant,
+kms:ListGrants,
+kms:RevokeGrant,
+kms:RetireGrant,
+redshift-serverless:CreateNamespace,
+redshift-serverless:GetNamespace,
+redshift-serverless:ListSnapshotCopyConfigurations,
+redshift-serverless:CreateSnapshotCopyConfiguration,
+redshift:GetResourcePolicy,
+redshift:PutResourcePolicy,
+secretsmanager:CreateSecret,
+secretsmanager:TagResource,
+secretsmanager:RotateSecret,
+secretsmanager:DescribeSecret
+ +### List +
+iam:PassRole,
+redshift-serverless:ListNamespaces
+ + +## Example +```sql +SELECT +region, +namespace_name +FROM awscc.redshiftserverless.namespaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md new file mode 100644 index 0000000000..720d7cb470 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md @@ -0,0 +1,111 @@ +--- +title: workgroup +hide_title: false +hide_table_of_contents: false +keywords: + - workgroup + - 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 +--- +Gets an individual workgroup resource + +## Overview + + + + + +
Nameworkgroup
TypeResource
Descriptionworkgroup
Idawscc.redshiftserverless.workgroup
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
workgroup_namestringThe name of the workgroup.
namespace_namestringThe namespace the workgroup is associated with.
base_capacityintegerThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).
max_capacityintegerThe max compute capacity of the workgroup in Redshift Processing Units (RPUs).
enhanced_vpc_routingbooleanThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
config_parametersarrayA 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.
security_group_idsarrayA list of security group IDs to associate with the workgroup.
subnet_idsarrayA list of subnet IDs the workgroup is associated with.
publicly_accessiblebooleanA value that specifies whether the workgroup can be accessible from a public network.
portintegerThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
tagsarrayThe map of the key-value pairs used to tag the workgroup.
workgroupobjectDefinition for workgroup resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workgroup resource, the following permissions are required: + +### Read +
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+redshift-serverless:GetWorkgroup
+ +### Update +
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+redshift-serverless:ListTagsForResource,
+redshift-serverless:TagResource,
+redshift-serverless:UntagResource,
+redshift-serverless:GetWorkgroup,
+redshift-serverless:UpdateWorkgroup
+ +### Delete +
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+redshift-serverless:GetWorkgroup,
+redshift-serverless:DeleteWorkgroup
+ + +## Example +```sql +SELECT +region, +workgroup_name, +namespace_name, +base_capacity, +max_capacity, +enhanced_vpc_routing, +config_parameters, +security_group_ids, +subnet_ids, +publicly_accessible, +port, +tags, +workgroup +FROM awscc.redshiftserverless.workgroup +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkgroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md new file mode 100644 index 0000000000..851d936fb0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md @@ -0,0 +1,74 @@ +--- +title: workgroups +hide_title: false +hide_table_of_contents: false +keywords: + - workgroups + - 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 +--- +Retrieves a list of workgroups in a region + +## Overview + + + + + +
Nameworkgroups
TypeResource
Descriptionworkgroups
Idawscc.redshiftserverless.workgroups
+ +## Fields + + + + + +
NameDatatypeDescription
workgroup_namestringThe name of the workgroup.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workgroups resource, the following permissions are required: + +### Create +
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+redshift-serverless:CreateNamespace,
+redshift-serverless:CreateWorkgroup,
+redshift-serverless:GetWorkgroup
+ +### List +
+ec2:DescribeVpcAttribute,
+ec2:DescribeSecurityGroups,
+ec2:DescribeAddresses,
+ec2:DescribeInternetGateways,
+ec2:DescribeSubnets,
+ec2:DescribeAccountAttributes,
+ec2:DescribeAvailabilityZones,
+redshift-serverless:ListWorkgroups
+ + +## Example +```sql +SELECT +region, +workgroup_name +FROM awscc.redshiftserverless.workgroups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/application/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/application/index.md new file mode 100644 index 0000000000..00462f6d44 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/application/index.md @@ -0,0 +1,102 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.refactorspaces.application
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
api_gateway_proxyobject
arnstring
api_gateway_idstring
vpc_link_idstring
nlb_arnstring
nlb_namestring
application_identifierstring
environment_identifierstring
namestring
proxy_typestring
vpc_idstring
stage_namestring
proxy_urlstring
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+refactor-spaces:GetApplication,
+refactor-spaces:ListTagsForResource
+ +### Delete +
+refactor-spaces:GetApplication,
+refactor-spaces:DeleteApplication,
+refactor-spaces:UntagResource,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:DeleteRoute,
+ec2:DeleteSecurityGroup,
+ec2:DeleteTransitGateway,
+ec2:DeleteTransitGatewayVpcAttachment,
+ec2:DeleteVpcEndpointServiceConfigurations,
+ec2:DeleteTags,
+ec2:RevokeSecurityGroupIngress,
+elasticloadbalancing:DeleteLoadBalancer,
+apigateway:Update*,
+apigateway:Delete*,
+apigateway:Get*,
+apigateway:Put*
+ + +## Example +```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, +tags +FROM awscc.refactorspaces.application +WHERE region = 'us-east-1' +AND data__Identifier = '<EnvironmentIdentifier>' +AND data__Identifier = '<ApplicationIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md new file mode 100644 index 0000000000..661c7df158 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md @@ -0,0 +1,86 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.refactorspaces.applications
+ +## Fields + + + + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+refactor-spaces:GetApplication,
+refactor-spaces:CreateApplication,
+refactor-spaces:TagResource,
+ec2:CreateTags,
+ec2:CreateVpcEndpointServiceConfiguration,
+ec2:DescribeVpcs,
+ec2:DescribeSubnets,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:DescribeAccountAttributes,
+ec2:DescribeInternetGateways,
+ec2:ModifyVpcEndpointServicePermissions,
+apigateway:DELETE,
+apigateway:GET,
+apigateway:PATCH,
+apigateway:POST,
+apigateway:PUT,
+apigateway:UpdateRestApiPolicy,
+apigateway:Update*,
+apigateway:Delete*,
+apigateway:Get*,
+apigateway:Put*,
+elasticloadbalancing:CreateLoadBalancer,
+elasticloadbalancing:DescribeLoadBalancers,
+elasticloadbalancing:DescribeTags,
+elasticloadbalancing:AddTags,
+iam:CreateServiceLinkedRole
+ +### List +
+refactor-spaces:ListApplications,
+refactor-spaces:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +environment_identifier, +application_identifier +FROM awscc.refactorspaces.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md new file mode 100644 index 0000000000..994a0c6a52 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md @@ -0,0 +1,81 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.refactorspaces.environment
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring
environment_identifierstring
namestring
network_fabric_typestring
arnstring
transit_gateway_idstring
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+refactor-spaces:GetEnvironment,
+refactor-spaces:ListTagsForResource
+ +### Delete +
+refactor-spaces:GetEnvironment,
+refactor-spaces:DeleteEnvironment,
+refactor-spaces:UntagResource,
+ec2:DescribeTransitGateways,
+ec2:DescribeTransitGatewayVpcAttachments,
+ec2:DeleteTransitGateway,
+ec2:DeleteTransitGatewayVpcAttachment,
+ec2:DeleteTags,
+ram:GetResourceShareAssociations,
+ram:DeleteResourceShare
+ + +## Example +```sql +SELECT +region, +description, +environment_identifier, +name, +network_fabric_type, +arn, +transit_gateway_id, +tags +FROM awscc.refactorspaces.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<EnvironmentIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md new file mode 100644 index 0000000000..936810cc4b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md @@ -0,0 +1,85 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.refactorspaces.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+refactor-spaces:CreateEnvironment,
+refactor-spaces:GetEnvironment,
+refactor-spaces:TagResource,
+ec2:CreateTransitGateway,
+ec2:AuthorizeSecurityGroupIngress,
+ec2:CreateSecurityGroup,
+ec2:CreateTags,
+ec2:DescribeNetworkInterfaces,
+ec2:DescribeRouteTables,
+ec2:DescribeSecurityGroups,
+ec2:DescribeSubnets,
+ec2:DescribeTags,
+ec2:DescribeTransitGateways,
+ec2:DescribeTransitGatewayVpcAttachments,
+ec2:DescribeVpcEndpointServiceConfigurations,
+ec2:ModifyVpcEndpointServicePermissions,
+ec2:RevokeSecurityGroupIngress,
+ram:AssociateResourceShare,
+ram:CreateResourceShare,
+ram:GetResourceShareAssociations,
+ram:GetResourceShares,
+ram:TagResource,
+ram:GetResourceShareInvitations,
+ram:AcceptResourceShareInvitation,
+ram:DisassociateResourceShare,
+tag:GetResources,
+iam:CreateServiceLinkedRole
+ +### List +
+refactor-spaces:ListEnvironments,
+refactor-spaces:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +environment_identifier +FROM awscc.refactorspaces.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/index.md new file mode 100644 index 0000000000..039d404210 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/index.md @@ -0,0 +1,45 @@ +--- +title: refactorspaces +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The refactorspaces service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+application
+applications
+environment
+environments +
+
+route
+routes
+service
+services +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/route/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/route/index.md new file mode 100644 index 0000000000..8c0e4c019e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/route/index.md @@ -0,0 +1,130 @@ +--- +title: route +hide_title: false +hide_table_of_contents: false +keywords: + - route + - 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 +--- +Gets an individual route resource + +## Overview + + + + + +
Nameroute
TypeResource
Descriptionroute
Idawscc.refactorspaces.route
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
path_resource_to_idstring
arnstring
application_identifierstring
environment_identifierstring
route_identifierstring
route_typestring
service_identifierstring
default_routeobject
uri_path_routeobject
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the route resource, the following permissions are required: + +### Read +
+refactor-spaces:GetRoute,
+refactor-spaces:ListTagsForResource
+ +### Delete +
+refactor-spaces:DeleteRoute,
+refactor-spaces:GetRoute,
+refactor-spaces:UntagResource,
+apigateway:GET,
+apigateway:PATCH,
+apigateway:POST,
+apigateway:PUT,
+apigateway:DELETE,
+apigateway:UpdateRestApiPolicy,
+lambda:GetFunctionConfiguration,
+lambda:AddPermission,
+elasticloadbalancing:DescribeListeners,
+elasticloadbalancing:DescribeTargetGroups,
+elasticloadbalancing:CreateListener,
+elasticloadbalancing:CreateTargetGroup,
+elasticloadbalancing:DeleteListener,
+elasticloadbalancing:DeleteTargetGroup,
+elasticloadbalancing:DescribeTags,
+elasticloadbalancing:AddTags,
+elasticloadbalancing:RegisterTargets,
+elasticloadbalancing:DescribeTargetHealth,
+ec2:DescribeSubnets,
+tag:GetResources
+ +### Update +
+refactor-spaces:UpdateRoute,
+refactor-spaces:GetRoute,
+refactor-spaces:TagResource,
+iam:CreateServiceLinkedRole,
+apigateway:GET,
+apigateway:PATCH,
+apigateway:POST,
+apigateway:PUT,
+apigateway:DELETE,
+apigateway:UpdateRestApiPolicy,
+lambda:GetFunctionConfiguration,
+lambda:AddPermission,
+elasticloadbalancing:DescribeListeners,
+elasticloadbalancing:DescribeTargetGroups,
+elasticloadbalancing:CreateListener,
+elasticloadbalancing:CreateTargetGroup,
+elasticloadbalancing:DeleteListener,
+elasticloadbalancing:DeleteTargetGroup,
+elasticloadbalancing:DescribeTags,
+elasticloadbalancing:AddTags,
+elasticloadbalancing:RegisterTargets,
+elasticloadbalancing:DescribeTargetHealth,
+ec2:DescribeSubnets,
+ec2:DescribeSubnets,
+tag:GetResources
+ + +## Example +```sql +SELECT +region, +path_resource_to_id, +arn, +application_identifier, +environment_identifier, +route_identifier, +route_type, +service_identifier, +default_route, +uri_path_route, +tags +FROM awscc.refactorspaces.route +WHERE region = 'us-east-1' +AND data__Identifier = '<EnvironmentIdentifier>' +AND data__Identifier = '<ApplicationIdentifier>' +AND data__Identifier = '<RouteIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md new file mode 100644 index 0000000000..f17560a225 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md @@ -0,0 +1,84 @@ +--- +title: routes +hide_title: false +hide_table_of_contents: false +keywords: + - routes + - 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 +--- +Retrieves a list of routes in a region + +## Overview + + + + + +
Nameroutes
TypeResource
Descriptionroutes
Idawscc.refactorspaces.routes
+ +## Fields + + + + + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
route_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the routes resource, the following permissions are required: + +### Create +
+refactor-spaces:CreateRoute,
+refactor-spaces:GetRoute,
+refactor-spaces:TagResource,
+iam:CreateServiceLinkedRole,
+apigateway:GET,
+apigateway:PATCH,
+apigateway:POST,
+apigateway:PUT,
+apigateway:DELETE,
+apigateway:UpdateRestApiPolicy,
+lambda:GetFunctionConfiguration,
+lambda:AddPermission,
+elasticloadbalancing:DescribeListeners,
+elasticloadbalancing:DescribeTargetGroups,
+elasticloadbalancing:CreateListener,
+elasticloadbalancing:CreateTargetGroup,
+elasticloadbalancing:DescribeTags,
+elasticloadbalancing:AddTags,
+elasticloadbalancing:RegisterTargets,
+elasticloadbalancing:DescribeTargetHealth,
+ec2:DescribeSubnets,
+tag:GetResources
+ +### List +
+refactor-spaces:ListRoutes,
+refactor-spaces:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +environment_identifier, +application_identifier, +route_identifier +FROM awscc.refactorspaces.routes +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/service/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/service/index.md new file mode 100644 index 0000000000..d82f270157 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/service/index.md @@ -0,0 +1,94 @@ +--- +title: service +hide_title: false +hide_table_of_contents: false +keywords: + - service + - 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 +--- +Gets an individual service resource + +## Overview + + + + + +
Nameservice
TypeResource
Descriptionservice
Idawscc.refactorspaces.service
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
application_identifierstring
descriptionstring
endpoint_typestring
environment_identifierstring
lambda_endpointobject
namestring
service_identifierstring
url_endpointobject
vpc_idstring
tagsarrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +
+refactor-spacess:GetService,
+refactor-spaces:ListTagsForResource
+ +### Delete +
+refactor-spaces:DeleteService,
+refactor-spaces:GetService,
+refactor-spaces:UntagResource,
+ram:DisassociateResourceShare,
+ec2:DescribeNetworkInterfaces,
+ec2:DescribeRouteTables,
+ec2:DescribeTransitGatewayVpcAttachments,
+ec2:DescribeSecurityGroups,
+ec2:DeleteSecurityGroup,
+ec2:DeleteRoute,
+ec2:RevokeSecurityGroupIngress,
+ec2:DeleteTransitGatewayVpcAttachment,
+ec2:DeleteTags
+ + +## Example +```sql +SELECT +region, +arn, +application_identifier, +description, +endpoint_type, +environment_identifier, +lambda_endpoint, +name, +service_identifier, +url_endpoint, +vpc_id, +tags +FROM awscc.refactorspaces.service +WHERE region = 'us-east-1' +AND data__Identifier = '<EnvironmentIdentifier>' +AND data__Identifier = '<ApplicationIdentifier>' +AND data__Identifier = '<ServiceIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/services/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/services/index.md new file mode 100644 index 0000000000..82a23dcf1e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/refactorspaces/services/index.md @@ -0,0 +1,75 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - 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 +--- +Retrieves a list of services in a region + +## Overview + + + + + +
Nameservices
TypeResource
Descriptionservices
Idawscc.refactorspaces.services
+ +## Fields + + + + + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
service_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +
+refactor-spaces:CreateService,
+refactor-spaces:GetService,
+refactor-spaces:TagResource,
+ec2:DescribeVpcs,
+ec2:DescribeSubnets,
+ec2:DescribeRouteTables,
+ec2:CreateTags,
+ec2:CreateTransitGatewayVpcAttachment,
+ec2:DescribeTransitGatewayVpcAttachments,
+ec2:CreateSecurityGroup,
+ec2:AuthorizeSecurityGroupIngress,
+ec2:CreateRoute,
+lambda:GetFunctionConfiguration
+ +### List +
+refactor-spaces:ListServices,
+refactor-spaces:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +environment_identifier, +application_identifier, +service_identifier +FROM awscc.refactorspaces.services +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rekognition/collection/index.md b/docs/awscc-docs/providers/awscc/rekognition/collection/index.md new file mode 100644 index 0000000000..7389788cc0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rekognition/collection/index.md @@ -0,0 +1,71 @@ +--- +title: collection +hide_title: false +hide_table_of_contents: false +keywords: + - collection + - 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 +--- +Gets an individual collection resource + +## Overview + + + + + +
Namecollection
TypeResource
Descriptioncollection
Idawscc.rekognition.collection
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
collection_idstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the collection resource, the following permissions are required: + +### Read +
+rekognition:DescribeCollection,
+rekognition:ListTagsForResource
+ +### Update +
+rekognition:TagResource,
+rekognition:UntagResource,
+rekognition:DescribeCollection,
+rekognition:ListTagsForResource
+ +### Delete +
+rekognition:DeleteCollection
+ + +## Example +```sql +SELECT +region, +arn, +collection_id, +tags +FROM awscc.rekognition.collection +WHERE region = 'us-east-1' +AND data__Identifier = '<CollectionId>' +``` diff --git a/docs/awscc-docs/providers/awscc/rekognition/collections/index.md b/docs/awscc-docs/providers/awscc/rekognition/collections/index.md new file mode 100644 index 0000000000..f7714a6245 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rekognition/collections/index.md @@ -0,0 +1,61 @@ +--- +title: collections +hide_title: false +hide_table_of_contents: false +keywords: + - collections + - 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 +--- +Retrieves a list of collections in a region + +## Overview + + + + + +
Namecollections
TypeResource
Descriptioncollections
Idawscc.rekognition.collections
+ +## Fields + + + + + +
NameDatatypeDescription
collection_idundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the collections resource, the following permissions are required: + +### Create +
+rekognition:CreateCollection,
+rekognition:DescribeCollection,
+rekognition:ListTagsForResource,
+rekognition:TagResource
+ +### List +
+rekognition:ListCollections
+ + +## Example +```sql +SELECT +region, +collection_id +FROM awscc.rekognition.collections +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rekognition/index.md b/docs/awscc-docs/providers/awscc/rekognition/index.md new file mode 100644 index 0000000000..092dc796f8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rekognition/index.md @@ -0,0 +1,43 @@ +--- +title: rekognition +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The rekognition service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+collection
+collections
+project +
+
+projects
+stream_processor
+stream_processors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/rekognition/project/index.md b/docs/awscc-docs/providers/awscc/rekognition/project/index.md new file mode 100644 index 0000000000..93296281ca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rekognition/project/index.md @@ -0,0 +1,66 @@ +--- +title: project +hide_title: false +hide_table_of_contents: false +keywords: + - project + - 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 +--- +Gets an individual project resource + +## Overview + + + + + +
Nameproject
TypeResource
Descriptionproject
Idawscc.rekognition.project
+ +## Fields + + + + + + +
NameDatatypeDescription
arnstring
project_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +
+rekognition:DescribeProjects
+ +### Update +
+
+ +### Delete +
+rekognition:DescribeProjects,
+rekognition:DeleteProject
+ + +## Example +```sql +SELECT +region, +arn, +project_name +FROM awscc.rekognition.project +WHERE region = 'us-east-1' +AND data__Identifier = '<ProjectName>' +``` diff --git a/docs/awscc-docs/providers/awscc/rekognition/projects/index.md b/docs/awscc-docs/providers/awscc/rekognition/projects/index.md new file mode 100644 index 0000000000..279ee88225 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rekognition/projects/index.md @@ -0,0 +1,58 @@ +--- +title: projects +hide_title: false +hide_table_of_contents: false +keywords: + - projects + - 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 +--- +Retrieves a list of projects in a region + +## Overview + + + + + +
Nameprojects
TypeResource
Descriptionprojects
Idawscc.rekognition.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_nameundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +
+rekognition:CreateProject
+ +### List +
+rekognition:DescribeProjects
+ + +## Example +```sql +SELECT +region, +project_name +FROM awscc.rekognition.projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md b/docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md new file mode 100644 index 0000000000..514fd603eb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md @@ -0,0 +1,97 @@ +--- +title: stream_processor +hide_title: false +hide_table_of_contents: false +keywords: + - stream_processor + - 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 +--- +Gets an individual stream_processor resource + +## Overview + + + + + +
Namestream_processor
TypeResource
Descriptionstream_processor
Idawscc.rekognition.stream_processor
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
kms_key_idstringThe KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
role_arnstringARN 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.
kinesis_video_streamobject
face_search_settingsobject
connected_home_settingsobject
kinesis_data_streamobject
s3_destinationobject
notification_channelobject
data_sharing_preferenceobject
polygon_regions_of_interestarrayThe 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
bounding_box_regions_of_interestarrayThe 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%.
statusstringCurrent status of the stream processor.
status_messagestringDetailed status message about the stream processor.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stream_processor resource, the following permissions are required: + +### Read +
+rekognition:DescribeStreamProcessor,
+rekognition:ListTagsForResource
+ +### Update +
+rekognition:TagResource,
+rekognition:UntagResource,
+rekognition:ListTagsForResource,
+rekognition:DescribeStreamProcessor
+ +### Delete +
+rekognition:DeleteStreamProcessor
+ + +## Example +```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, +tags +FROM awscc.rekognition.stream_processor +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md b/docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md new file mode 100644 index 0000000000..b42be69116 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md @@ -0,0 +1,62 @@ +--- +title: stream_processors +hide_title: false +hide_table_of_contents: false +keywords: + - stream_processors + - 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 +--- +Retrieves a list of stream_processors in a region + +## Overview + + + + + +
Namestream_processors
TypeResource
Descriptionstream_processors
Idawscc.rekognition.stream_processors
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the stream_processors resource, the following permissions are required: + +### Create +
+rekognition:CreateStreamProcessor,
+iam:PassRole,
+rekognition:DescribeStreamProcessor,
+rekognition:ListTagsForResource,
+rekognition:TagResource
+ +### List +
+rekognition:ListStreamProcessors
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.rekognition.stream_processors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/app/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/app/index.md new file mode 100644 index 0000000000..369d5ecdec --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resiliencehub/app/index.md @@ -0,0 +1,107 @@ +--- +title: app +hide_title: false +hide_table_of_contents: false +keywords: + - app + - 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 +--- +Gets an individual app resource + +## Overview + + + + + +
Nameapp
TypeResource
Descriptionapp
Idawscc.resiliencehub.app
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the app.
descriptionstringApp description.
app_arnstringAmazon Resource Name (ARN) of the App.
resiliency_policy_arnstringAmazon Resource Name (ARN) of the Resiliency Policy.
tagsobject
app_template_bodystringA string containing full ResilienceHub app template body.
resource_mappingsarrayAn array of ResourceMapping objects.
app_assessment_schedulestringAssessment execution schedule.
permission_modelobject
event_subscriptionsarrayThe list of events you would like to subscribe and get notification for.
drift_statusstringIndicates if compliance drifts (deviations) were detected while running an assessment for your application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app resource, the following permissions are required: + +### Read +
+resiliencehub:DescribeApp,
+resiliencehub:DescribeAppVersionTemplate,
+resiliencehub:ListAppVersionResourceMappings,
+resiliencehub:ListTagsForResource
+ +### Update +
+cloudformation:DescribeStacks,
+cloudformation:ListStackResources,
+s3:GetBucketLocation,
+s3:GetObject,
+s3:ListAllMyBuckets,
+autoscaling:DescribeAutoScalingGroups,
+apigateway:GET,
+ec2:Describe*,
+ecs:DescribeServices,
+eks:DescribeCluster,
+elasticfilesystem:DescribeFileSystems,
+elasticloadbalancing:DescribeLoadBalancers,
+lambda:GetFunction*,
+rds:Describe*,
+dynamodb:Describe*,
+sqs:GetQueueAttributes,
+sns:GetTopicAttributes,
+route53:List*,
+iam:PassRole,
+resiliencehub:*
+ +### Delete +
+resiliencehub:DeleteApp,
+resiliencehub:UntagResource,
+resiliencehub:ListApps
+ + +## Example +```sql +SELECT +region, +name, +description, +app_arn, +resiliency_policy_arn, +tags, +app_template_body, +resource_mappings, +app_assessment_schedule, +permission_model, +event_subscriptions, +drift_status +FROM awscc.resiliencehub.app +WHERE region = 'us-east-1' +AND data__Identifier = '<AppArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md new file mode 100644 index 0000000000..c89e4b6b05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md @@ -0,0 +1,77 @@ +--- +title: apps +hide_title: false +hide_table_of_contents: false +keywords: + - apps + - 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 +--- +Retrieves a list of apps in a region + +## Overview + + + + + +
Nameapps
TypeResource
Descriptionapps
Idawscc.resiliencehub.apps
+ +## Fields + + + + + +
NameDatatypeDescription
app_arnstringAmazon Resource Name (ARN) of the App.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the apps resource, the following permissions are required: + +### Create +
+cloudformation:DescribeStacks,
+cloudformation:ListStackResources,
+s3:GetBucketLocation,
+s3:GetObject,
+s3:ListAllMyBuckets,
+autoscaling:DescribeAutoScalingGroups,
+apigateway:GET,
+ec2:Describe*,
+ecs:DescribeServices,
+eks:DescribeCluster,
+elasticfilesystem:DescribeFileSystems,
+elasticloadbalancing:DescribeLoadBalancers,
+lambda:GetFunction*,
+rds:Describe*,
+dynamodb:Describe*,
+sqs:GetQueueAttributes,
+sns:GetTopicAttributes,
+route53:List*,
+iam:PassRole,
+resiliencehub:*
+ +### List +
+resiliencehub:ListApps
+ + +## Example +```sql +SELECT +region, +app_arn +FROM awscc.resiliencehub.apps +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/index.md new file mode 100644 index 0000000000..26b7110c23 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resiliencehub/index.md @@ -0,0 +1,41 @@ +--- +title: resiliencehub +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The resiliencehub service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+app
+apps +
+
+resiliency_policies
+resiliency_policy +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policies/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policies/index.md new file mode 100644 index 0000000000..03d1a342b4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policies/index.md @@ -0,0 +1,60 @@ +--- +title: resiliency_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resiliency_policies + - 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 +--- +Retrieves a list of resiliency_policies in a region + +## Overview + + + + + +
Nameresiliency_policies
TypeResource
Descriptionresiliency_policies
Idawscc.resiliencehub.resiliency_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_arnstringAmazon Resource Name (ARN) of the Resiliency Policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resiliency_policies resource, the following permissions are required: + +### Create +
+resiliencehub:CreateResiliencyPolicy,
+resiliencehub:DescribeResiliencyPolicy,
+resiliencehub:TagResource
+ +### List +
+resiliencehub:ListResiliencyPolicies
+ + +## Example +```sql +SELECT +region, +policy_arn +FROM awscc.resiliencehub.resiliency_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md new file mode 100644 index 0000000000..24e538332a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md @@ -0,0 +1,81 @@ +--- +title: resiliency_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resiliency_policy + - 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 +--- +Gets an individual resiliency_policy resource + +## Overview + + + + + +
Nameresiliency_policy
TypeResource
Descriptionresiliency_policy
Idawscc.resiliencehub.resiliency_policy
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
policy_namestringName of Resiliency Policy.
policy_descriptionstringDescription of Resiliency Policy.
data_location_constraintstringData Location Constraint of the Policy.
tierstringResiliency Policy Tier.
policyobject
policy_arnstringAmazon Resource Name (ARN) of the Resiliency Policy.
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resiliency_policy resource, the following permissions are required: + +### Update +
+resiliencehub:DescribeResiliencyPolicy,
+resiliencehub:UpdateResiliencyPolicy,
+resiliencehub:TagResource,
+resiliencehub:UntagResource,
+resiliencehub:ListTagsForResource
+ +### Read +
+resiliencehub:DescribeResiliencyPolicy,
+resiliencehub:ListTagsForResource
+ +### Delete +
+resiliencehub:DeleteResiliencyPolicy,
+resiliencehub:UntagResource
+ + +## Example +```sql +SELECT +region, +policy_name, +policy_description, +data_location_constraint, +tier, +policy, +policy_arn, +tags +FROM awscc.resiliencehub.resiliency_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<PolicyArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_association/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_association/index.md new file mode 100644 index 0000000000..40486ab22c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_association/index.md @@ -0,0 +1,67 @@ +--- +title: default_view_association +hide_title: false +hide_table_of_contents: false +keywords: + - default_view_association + - 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 +--- +Gets an individual default_view_association resource + +## Overview + + + + + +
Namedefault_view_association
TypeResource
Descriptiondefault_view_association
Idawscc.resourceexplorer2.default_view_association
+ +## Fields + + + + + + +
NameDatatypeDescription
view_arnstring
associated_aws_principalstringThe AWS principal that the default view is associated with, used as the unique identifier for this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the default_view_association resource, the following permissions are required: + +### Update +
+resource-explorer-2:GetDefaultView,
+resource-explorer-2:AssociateDefaultView
+ +### Read +
+resource-explorer-2:GetDefaultView
+ +### Delete +
+resource-explorer-2:GetDefaultView,
+resource-explorer-2:DisassociateDefaultView
+ + +## Example +```sql +SELECT +region, +view_arn, +associated_aws_principal +FROM awscc.resourceexplorer2.default_view_association +WHERE region = 'us-east-1' +AND data__Identifier = '<AssociatedAwsPrincipal>' +``` diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_associations/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_associations/index.md new file mode 100644 index 0000000000..65e8f1b1f7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_associations/index.md @@ -0,0 +1,55 @@ +--- +title: default_view_associations +hide_title: false +hide_table_of_contents: false +keywords: + - default_view_associations + - 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 +--- +Retrieves a list of default_view_associations in a region + +## Overview + + + + + +
Namedefault_view_associations
TypeResource
Descriptiondefault_view_associations
Idawscc.resourceexplorer2.default_view_associations
+ +## Fields + + + + + +
NameDatatypeDescription
associated_aws_principalstringThe AWS principal that the default view is associated with, used as the unique identifier for this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the default_view_associations resource, the following permissions are required: + +### Create +
+resource-explorer-2:GetDefaultView,
+resource-explorer-2:AssociateDefaultView
+ + +## Example +```sql +SELECT +region, +associated_aws_principal +FROM awscc.resourceexplorer2.default_view_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/index.md new file mode 100644 index 0000000000..8c56a5ecf8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourceexplorer2/index.md @@ -0,0 +1,43 @@ +--- +title: resourceexplorer2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The resourceexplorer2 service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+default_view_association
+default_view_associations
+index +
+
+indices
+view
+views +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/index/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/index/index.md new file mode 100644 index 0000000000..9eeb06b91b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourceexplorer2/index/index.md @@ -0,0 +1,75 @@ +--- +title: index +hide_title: false +hide_table_of_contents: false +keywords: + - index + - 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 +--- +Gets an individual index resource + +## Overview + + + + + +
Nameindex
TypeResource
Descriptionindex
Idawscc.resourceexplorer2.index
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring
tagsobject
typestring
index_statestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the index resource, the following permissions are required: + +### Update +
+resource-explorer-2:GetIndex,
+resource-explorer-2:UpdateIndexType,
+resource-explorer-2:TagResource,
+resource-explorer-2:UntagResource,
+resource-explorer-2:ListTagsForResource
+ +### Delete +
+resource-explorer-2:DeleteIndex,
+resource-explorer-2:GetIndex,
+resource-explorer-2:UntagResource
+ +### Read +
+resource-explorer-2:GetIndex
+ + +## Example +```sql +SELECT +region, +arn, +tags, +type, +index_state +FROM awscc.resourceexplorer2.index +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md new file mode 100644 index 0000000000..3791ea52e8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md @@ -0,0 +1,63 @@ +--- +title: indices +hide_title: false +hide_table_of_contents: false +keywords: + - indices + - 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 +--- +Retrieves a list of indices in a region + +## Overview + + + + + +
Nameindices
TypeResource
Descriptionindices
Idawscc.resourceexplorer2.indices
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the indices resource, the following permissions are required: + +### Create +
+resource-explorer-2:CreateIndex,
+resource-explorer-2:GetIndex,
+resource-explorer-2:TagResource,
+resource-explorer-2:UpdateIndexType,
+resource-explorer-2:DeleteIndex,
+iam:CreateServiceLinkedRole
+ +### List +
+resource-explorer-2:ListIndexes
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.resourceexplorer2.indices +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md new file mode 100644 index 0000000000..fc073a87cf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md @@ -0,0 +1,78 @@ +--- +title: view +hide_title: false +hide_table_of_contents: false +keywords: + - view + - 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 +--- +Gets an individual view resource + +## Overview + + + + + +
Nameview
TypeResource
Descriptionview
Idawscc.resourceexplorer2.view
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
filtersobject
included_propertiesarray
scopestring
tagsobject
view_arnstring
view_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the view resource, the following permissions are required: + +### Read +
+resource-explorer-2:GetView
+ +### Update +
+resource-explorer-2:UpdateView,
+resource-explorer-2:TagResource,
+resource-explorer-2:UntagResource,
+resource-explorer-2:ListTagsForResource
+ +### Delete +
+resource-explorer-2:DeleteView,
+resource-explorer-2:GetView,
+resource-explorer-2:UntagResource
+ + +## Example +```sql +SELECT +region, +filters, +included_properties, +scope, +tags, +view_arn, +view_name +FROM awscc.resourceexplorer2.view +WHERE region = 'us-east-1' +AND data__Identifier = '<ViewArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md new file mode 100644 index 0000000000..18170fb033 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md @@ -0,0 +1,59 @@ +--- +title: views +hide_title: false +hide_table_of_contents: false +keywords: + - views + - 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 +--- +Retrieves a list of views in a region + +## Overview + + + + + +
Nameviews
TypeResource
Descriptionviews
Idawscc.resourceexplorer2.views
+ +## Fields + + + + + +
NameDatatypeDescription
view_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the views resource, the following permissions are required: + +### Create +
+resource-explorer-2:CreateView,
+resource-explorer-2:TagResource
+ +### List +
+resource-explorer-2:ListViews
+ + +## Example +```sql +SELECT +region, +view_arn +FROM awscc.resourceexplorer2.views +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/resourcegroups/group/index.md b/docs/awscc-docs/providers/awscc/resourcegroups/group/index.md new file mode 100644 index 0000000000..9c2ffc9568 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourcegroups/group/index.md @@ -0,0 +1,90 @@ +--- +title: group +hide_title: false +hide_table_of_contents: false +keywords: + - group + - 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 +--- +Gets an individual group resource + +## Overview + + + + + +
Namegroup
TypeResource
Descriptiongroup
Idawscc.resourcegroups.group
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the resource group
descriptionstringThe description of the resource group
resource_queryobject
tagsarray
arnstringThe Resource Group ARN.
configurationarray
resourcesarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +
+resource-groups:GetGroup,
+resource-groups:GetGroupQuery,
+resource-groups:GetTags,
+resource-groups:GetGroupConfiguration,
+resource-groups:ListGroupResources
+ +### Update +
+resource-groups:UpdateGroup,
+resource-groups:GetTags,
+resource-groups:GetGroupQuery,
+resource-groups:UpdateGroupQuery,
+resource-groups:Tag,
+resource-groups:Untag,
+resource-groups:PutGroupConfiguration,
+resource-groups:GetGroupConfiguration,
+resource-groups:ListGroupResources,
+resource-groups:GroupResources,
+resource-groups:UnGroupResources
+ +### Delete +
+resource-groups:DeleteGroup,
+resource-groups:UnGroupResources
+ + +## Example +```sql +SELECT +region, +name, +description, +resource_query, +tags, +arn, +configuration, +resources +FROM awscc.resourcegroups.group +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md b/docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md new file mode 100644 index 0000000000..2f711b7529 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md @@ -0,0 +1,63 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - groups + - 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 +--- +Retrieves a list of groups in a region + +## Overview + + + + + +
Namegroups
TypeResource
Descriptiongroups
Idawscc.resourcegroups.groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the resource group
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +
+resource-groups:CreateGroup,
+resource-groups:Tag,
+cloudformation:DescribeStacks,
+cloudformation:ListStackResources,
+resource-groups:ListGroupResources,
+resource-groups:GroupResources
+ +### List +
+resource-groups:ListGroups
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.resourcegroups.groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/resourcegroups/index.md b/docs/awscc-docs/providers/awscc/resourcegroups/index.md new file mode 100644 index 0000000000..0281c37377 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/resourcegroups/index.md @@ -0,0 +1,39 @@ +--- +title: resourcegroups +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The resourcegroups service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+group +
+
+groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/robomaker/fleet/index.md b/docs/awscc-docs/providers/awscc/robomaker/fleet/index.md new file mode 100644 index 0000000000..ea5b566ce3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/fleet/index.md @@ -0,0 +1,68 @@ +--- +title: fleet +hide_title: false +hide_table_of_contents: false +keywords: + - fleet + - 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 +--- +Gets an individual fleet resource + +## Overview + + + + + +
Namefleet
TypeResource
Descriptionfleet
Idawscc.robomaker.fleet
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
tagsobject
namestringThe name of the fleet.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Read +
+robomaker:DescribeFleet
+ +### Delete +
+robomaker:DeleteFleet
+ +### Update +
+robomaker:TagResource,
+robomaker:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +tags, +name +FROM awscc.robomaker.fleet +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/fleets/index.md b/docs/awscc-docs/providers/awscc/robomaker/fleets/index.md new file mode 100644 index 0000000000..43effc5202 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/fleets/index.md @@ -0,0 +1,58 @@ +--- +title: fleets +hide_title: false +hide_table_of_contents: false +keywords: + - fleets + - 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 +--- +Retrieves a list of fleets in a region + +## Overview + + + + + +
Namefleets
TypeResource
Descriptionfleets
Idawscc.robomaker.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +
+robomaker:CreateFleet
+ +### List +
+robomaker:ListFleets
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.robomaker.fleets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/index.md b/docs/awscc-docs/providers/awscc/robomaker/index.md new file mode 100644 index 0000000000..c649de6fbf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/index.md @@ -0,0 +1,49 @@ +--- +title: robomaker +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The robomaker service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+fleet
+fleets
+robot
+robot_application
+robot_application_version
+robot_application_versions +
+
+robot_applications
+robots
+simulation_application
+simulation_application_version
+simulation_application_versions
+simulation_applications +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/robomaker/robot/index.md b/docs/awscc-docs/providers/awscc/robomaker/robot/index.md new file mode 100644 index 0000000000..8fc2d50507 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/robot/index.md @@ -0,0 +1,76 @@ +--- +title: robot +hide_title: false +hide_table_of_contents: false +keywords: + - robot + - 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 +--- +Gets an individual robot resource + +## Overview + + + + + +
Namerobot
TypeResource
Descriptionrobot
Idawscc.robomaker.robot
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
fleetstringThe Amazon Resource Name (ARN) of the fleet.
architecturestringThe target architecture of the robot.
greengrass_group_idstringThe Greengrass group id.
tagsobject
namestringThe name for the robot.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the robot resource, the following permissions are required: + +### Read +
+robomaker:DescribeRobot
+ +### Delete +
+robomaker:DescribeRobot,
+robomaker:DeleteRobot,
+robomaker:DeregisterRobot
+ +### Update +
+robomaker:TagResource,
+robomaker:UntagResource
+ + +## Example +```sql +SELECT +region, +arn, +fleet, +architecture, +greengrass_group_id, +tags, +name +FROM awscc.robomaker.robot +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md b/docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md new file mode 100644 index 0000000000..258690ad4e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md @@ -0,0 +1,82 @@ +--- +title: robot_application +hide_title: false +hide_table_of_contents: false +keywords: + - robot_application + - 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 +--- +Gets an individual robot_application resource + +## Overview + + + + + +
Namerobot_application
TypeResource
Descriptionrobot_application
Idawscc.robomaker.robot_application
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the robot application.
sourcesarrayThe sources of the robot application.
environmentstringThe URI of the Docker image for the robot application.
robot_software_suiteobject
current_revision_idstringThe revision ID of robot application.
arnstring
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the robot_application resource, the following permissions are required: + +### Read +
+robomaker:DescribeRobotApplication
+ +### Update +
+robomaker:TagResource,
+robomaker:UntagResource,
+robomaker:UpdateRobotApplication,
+ecr:BatchGetImage,
+ecr:GetAuthorizationToken,
+ecr:BatchCheckLayerAvailability,
+ecr-public:GetAuthorizationToken
+ +### Delete +
+robomaker:DescribeRobotApplication,
+robomaker:DeleteRobotApplication
+ + +## Example +```sql +SELECT +region, +name, +sources, +environment, +robot_software_suite, +current_revision_id, +arn, +tags +FROM awscc.robomaker.robot_application +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/robot_application_version/index.md b/docs/awscc-docs/providers/awscc/robomaker/robot_application_version/index.md new file mode 100644 index 0000000000..014700e752 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/robot_application_version/index.md @@ -0,0 +1,66 @@ +--- +title: robot_application_version +hide_title: false +hide_table_of_contents: false +keywords: + - robot_application_version + - 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 +--- +Gets an individual robot_application_version resource + +## Overview + + + + + +
Namerobot_application_version
TypeResource
Descriptionrobot_application_version
Idawscc.robomaker.robot_application_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
applicationstring
current_revision_idstringThe revision ID of robot application.
application_versionstring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the robot_application_version resource, the following permissions are required: + +### Delete +
+robomaker:DeleteRobotApplication,
+robomaker:DescribeRobotApplication
+ +### Read +
+robomaker:DescribeRobotApplication
+ + +## Example +```sql +SELECT +region, +application, +current_revision_id, +application_version, +arn +FROM awscc.robomaker.robot_application_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/robot_application_versions/index.md b/docs/awscc-docs/providers/awscc/robomaker/robot_application_versions/index.md new file mode 100644 index 0000000000..29f4fc010b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/robot_application_versions/index.md @@ -0,0 +1,60 @@ +--- +title: robot_application_versions +hide_title: false +hide_table_of_contents: false +keywords: + - robot_application_versions + - 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 +--- +Retrieves a list of robot_application_versions in a region + +## Overview + + + + + +
Namerobot_application_versions
TypeResource
Descriptionrobot_application_versions
Idawscc.robomaker.robot_application_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the robot_application_versions resource, the following permissions are required: + +### Create +
+robomaker:CreateRobotApplicationVersion,
+s3:GetObject,
+ecr:BatchGetImage,
+ecr:GetAuthorizationToken,
+ecr:BatchCheckLayerAvailability,
+ecr-public:GetAuthorizationToken,
+sts:GetServiceBearerToken
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.robomaker.robot_application_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md b/docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md new file mode 100644 index 0000000000..4b1c6aca04 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md @@ -0,0 +1,65 @@ +--- +title: robot_applications +hide_title: false +hide_table_of_contents: false +keywords: + - robot_applications + - 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 +--- +Retrieves a list of robot_applications in a region + +## Overview + + + + + +
Namerobot_applications
TypeResource
Descriptionrobot_applications
Idawscc.robomaker.robot_applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the robot_applications resource, the following permissions are required: + +### Create +
+robomaker:CreateRobotApplication,
+robomaker:TagResource,
+robomaker:UntagResource,
+ecr:BatchGetImage,
+ecr:GetAuthorizationToken,
+ecr:BatchCheckLayerAvailability,
+ecr-public:GetAuthorizationToken,
+sts:GetServiceBearerToken
+ +### List +
+robomaker:ListRobotApplications
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.robomaker.robot_applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/robots/index.md b/docs/awscc-docs/providers/awscc/robomaker/robots/index.md new file mode 100644 index 0000000000..d74afbb4af --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/robots/index.md @@ -0,0 +1,59 @@ +--- +title: robots +hide_title: false +hide_table_of_contents: false +keywords: + - robots + - 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 +--- +Retrieves a list of robots in a region + +## Overview + + + + + +
Namerobots
TypeResource
Descriptionrobots
Idawscc.robomaker.robots
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the robots resource, the following permissions are required: + +### Create +
+robomaker:CreateRobot,
+robomaker:RegisterRobot
+ +### List +
+robomaker:ListRobots
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.robomaker.robots +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md b/docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md new file mode 100644 index 0000000000..50b3bc7502 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md @@ -0,0 +1,86 @@ +--- +title: simulation_application +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_application + - 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 +--- +Gets an individual simulation_application resource + +## Overview + + + + + +
Namesimulation_application
TypeResource
Descriptionsimulation_application
Idawscc.robomaker.simulation_application
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe name of the simulation application.
current_revision_idstringThe current revision id.
rendering_engineobjectThe rendering engine for the simulation application.
robot_software_suiteobjectThe robot software suite used by the simulation application.
simulation_software_suiteobjectThe simulation software suite used by the simulation application.
sourcesarrayThe sources of the simulation application.
environmentstringThe URI of the Docker image for the robot application.
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simulation_application resource, the following permissions are required: + +### Read +
+robomaker:DescribeSimulationApplication
+ +### Update +
+robomaker:TagResource,
+robomaker:UntagResource,
+robomaker:UpdateSimulationApplication,
+ecr:BatchGetImage,
+ecr:GetAuthorizationToken,
+ecr:BatchCheckLayerAvailability,
+ecr-public:GetAuthorizationToken
+ +### Delete +
+robomaker:DescribeSimulationApplication,
+robomaker:DeleteSimulationApplication
+ + +## Example +```sql +SELECT +region, +arn, +name, +current_revision_id, +rendering_engine, +robot_software_suite, +simulation_software_suite, +sources, +environment, +tags +FROM awscc.robomaker.simulation_application +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/simulation_application_version/index.md b/docs/awscc-docs/providers/awscc/robomaker/simulation_application_version/index.md new file mode 100644 index 0000000000..dc7e7fc5bd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/simulation_application_version/index.md @@ -0,0 +1,66 @@ +--- +title: simulation_application_version +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_application_version + - 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 +--- +Gets an individual simulation_application_version resource + +## Overview + + + + + +
Namesimulation_application_version
TypeResource
Descriptionsimulation_application_version
Idawscc.robomaker.simulation_application_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
applicationstring
current_revision_idstringThe revision ID of robot application.
application_versionstring
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simulation_application_version resource, the following permissions are required: + +### Delete +
+robomaker:DeleteSimulationApplication,
+robomaker:DescribeSimulationApplication
+ +### Read +
+robomaker:DescribeSimulationApplication
+ + +## Example +```sql +SELECT +region, +application, +current_revision_id, +application_version, +arn +FROM awscc.robomaker.simulation_application_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/simulation_application_versions/index.md b/docs/awscc-docs/providers/awscc/robomaker/simulation_application_versions/index.md new file mode 100644 index 0000000000..35d2a76bcc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/simulation_application_versions/index.md @@ -0,0 +1,60 @@ +--- +title: simulation_application_versions +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_application_versions + - 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 +--- +Retrieves a list of simulation_application_versions in a region + +## Overview + + + + + +
Namesimulation_application_versions
TypeResource
Descriptionsimulation_application_versions
Idawscc.robomaker.simulation_application_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simulation_application_versions resource, the following permissions are required: + +### Create +
+robomaker:CreateSimulationApplicationVersion,
+s3:GetObject,
+ecr:BatchGetImage,
+ecr:GetAuthorizationToken,
+ecr:BatchCheckLayerAvailability,
+ecr-public:GetAuthorizationToken,
+sts:GetServiceBearerToken
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.robomaker.simulation_application_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md b/docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md new file mode 100644 index 0000000000..71e914e546 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md @@ -0,0 +1,65 @@ +--- +title: simulation_applications +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_applications + - 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 +--- +Retrieves a list of simulation_applications in a region + +## Overview + + + + + +
Namesimulation_applications
TypeResource
Descriptionsimulation_applications
Idawscc.robomaker.simulation_applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simulation_applications resource, the following permissions are required: + +### Create +
+robomaker:CreateSimulationApplication,
+robomaker:TagResource,
+robomaker:UntagResource,
+ecr:BatchGetImage,
+ecr:GetAuthorizationToken,
+ecr:BatchCheckLayerAvailability,
+ecr-public:GetAuthorizationToken,
+sts:GetServiceBearerToken
+ +### List +
+robomaker:ListSimulationApplications
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.robomaker.simulation_applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md new file mode 100644 index 0000000000..f7b2137ad1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md @@ -0,0 +1,79 @@ +--- +title: crl +hide_title: false +hide_table_of_contents: false +keywords: + - crl + - 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 +--- +Gets an individual crl resource + +## Overview + + + + + +
Namecrl
TypeResource
Descriptioncrl
Idawscc.rolesanywhere.crl
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
crl_datastring
crl_idstring
enabledboolean
namestring
trust_anchor_arnstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the crl resource, the following permissions are required: + +### Read +
+rolesanywhere:GetCrl,
+rolesanywhere:ListTagsForResource
+ +### Update +
+rolesanywhere:EnableCrl,
+rolesanywhere:DisableCrl,
+rolesanywhere:UpdateCrl,
+rolesanywhere:TagResource,
+rolesanywhere:UntagResource,
+rolesanywhere:ListTagsForResource
+ +### Delete +
+rolesanywhere:DeleteCrl
+ + +## Example +```sql +SELECT +region, +crl_data, +crl_id, +enabled, +name, +trust_anchor_arn, +tags +FROM awscc.rolesanywhere.crl +WHERE region = 'us-east-1' +AND data__Identifier = '<CrlId>' +``` diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md new file mode 100644 index 0000000000..9d22adad81 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md @@ -0,0 +1,61 @@ +--- +title: crls +hide_title: false +hide_table_of_contents: false +keywords: + - crls + - 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 +--- +Retrieves a list of crls in a region + +## Overview + + + + + +
Namecrls
TypeResource
Descriptioncrls
Idawscc.rolesanywhere.crls
+ +## Fields + + + + + +
NameDatatypeDescription
crl_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the crls resource, the following permissions are required: + +### Create +
+rolesanywhere:ImportCrl,
+rolesanywhere:TagResource,
+rolesanywhere:ListTagsForResource
+ +### List +
+rolesanywhere:ListCrls,
+rolesanywhere:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +crl_id +FROM awscc.rolesanywhere.crls +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/index.md new file mode 100644 index 0000000000..60f51c847d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rolesanywhere/index.md @@ -0,0 +1,43 @@ +--- +title: rolesanywhere +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The rolesanywhere service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+crl
+crls
+profile +
+
+profiles
+trust_anchor
+trust_anchors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/profile/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/profile/index.md new file mode 100644 index 0000000000..1421cc11b9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rolesanywhere/profile/index.md @@ -0,0 +1,90 @@ +--- +title: profile +hide_title: false +hide_table_of_contents: false +keywords: + - profile + - 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 +--- +Gets an individual profile resource + +## Overview + + + + + +
Nameprofile
TypeResource
Descriptionprofile
Idawscc.rolesanywhere.profile
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
duration_secondsnumber
enabledboolean
managed_policy_arnsarray
namestring
profile_arnstring
profile_idstring
require_instance_propertiesboolean
role_arnsarray
session_policystring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profile resource, the following permissions are required: + +### Read +
+rolesanywhere:GetProfile,
+rolesanywhere:ListTagsForResource
+ +### Update +
+iam:GetRole,
+iam:GetPolicy,
+iam:PassRole,
+rolesanywhere:UpdateProfile,
+rolesanywhere:EnableProfile,
+rolesanywhere:DisableProfile,
+rolesanywhere:TagResource,
+rolesanywhere:UntagResource,
+rolesanywhere:ListTagsForResource
+ +### Delete +
+rolesanywhere:DeleteProfile
+ + +## Example +```sql +SELECT +region, +duration_seconds, +enabled, +managed_policy_arns, +name, +profile_arn, +profile_id, +require_instance_properties, +role_arns, +session_policy, +tags +FROM awscc.rolesanywhere.profile +WHERE region = 'us-east-1' +AND data__Identifier = '<ProfileId>' +``` diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md new file mode 100644 index 0000000000..486e86111c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md @@ -0,0 +1,64 @@ +--- +title: profiles +hide_title: false +hide_table_of_contents: false +keywords: + - profiles + - 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 +--- +Retrieves a list of profiles in a region + +## Overview + + + + + +
Nameprofiles
TypeResource
Descriptionprofiles
Idawscc.rolesanywhere.profiles
+ +## Fields + + + + + +
NameDatatypeDescription
profile_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +
+iam:GetRole,
+iam:GetPolicy,
+iam:PassRole,
+rolesanywhere:CreateProfile,
+rolesanywhere:TagResource,
+rolesanywhere:ListTagsForResource
+ +### List +
+rolesanywhere:ListProfiles,
+rolesanywhere:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +profile_id +FROM awscc.rolesanywhere.profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md new file mode 100644 index 0000000000..34c34b8bb3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md @@ -0,0 +1,85 @@ +--- +title: trust_anchor +hide_title: false +hide_table_of_contents: false +keywords: + - trust_anchor + - 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 +--- +Gets an individual trust_anchor resource + +## Overview + + + + + +
Nametrust_anchor
TypeResource
Descriptiontrust_anchor
Idawscc.rolesanywhere.trust_anchor
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
enabledboolean
namestring
notification_settingsarray
sourceobject
tagsarray
trust_anchor_idstring
trust_anchor_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_anchor resource, the following permissions are required: + +### Read +
+rolesanywhere:GetTrustAnchor,
+rolesanywhere:ListTagsForResource
+ +### Update +
+acm-pca:GetCertificateAuthorityCertificate,
+rolesanywhere:ListTagsForResource,
+rolesanywhere:TagResource,
+rolesanywhere:UntagResource,
+rolesanywhere:EnableTrustAnchor,
+rolesanywhere:DisableTrustAnchor,
+rolesanywhere:UpdateTrustAnchor,
+rolesanywhere:GetTrustAnchor,
+rolesanywhere:PutNotificationSettings,
+rolesanywhere:ResetNotificationSettings
+ +### Delete +
+rolesanywhere:DeleteTrustAnchor
+ + +## Example +```sql +SELECT +region, +enabled, +name, +notification_settings, +source, +tags, +trust_anchor_id, +trust_anchor_arn +FROM awscc.rolesanywhere.trust_anchor +WHERE region = 'us-east-1' +AND data__Identifier = '<TrustAnchorId>' +``` diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md new file mode 100644 index 0000000000..1d40116f45 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md @@ -0,0 +1,62 @@ +--- +title: trust_anchors +hide_title: false +hide_table_of_contents: false +keywords: + - trust_anchors + - 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 +--- +Retrieves a list of trust_anchors in a region + +## Overview + + + + + +
Nametrust_anchors
TypeResource
Descriptiontrust_anchors
Idawscc.rolesanywhere.trust_anchors
+ +## Fields + + + + + +
NameDatatypeDescription
trust_anchor_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_anchors resource, the following permissions are required: + +### Create +
+iam:CreateServiceLinkedRole,
+rolesanywhere:CreateTrustAnchor,
+rolesanywhere:TagResource,
+rolesanywhere:ListTagsForResource
+ +### List +
+rolesanywhere:ListTrustAnchors,
+rolesanywhere:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +trust_anchor_id +FROM awscc.rolesanywhere.trust_anchors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md b/docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md new file mode 100644 index 0000000000..b27831efc6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md @@ -0,0 +1,70 @@ +--- +title: cidr_collection +hide_title: false +hide_table_of_contents: false +keywords: + - cidr_collection + - 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 +--- +Gets an individual cidr_collection resource + +## Overview + + + + + +
Namecidr_collection
TypeResource
Descriptioncidr_collection
Idawscc.route53.cidr_collection
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstringUUID of the CIDR collection.
namestringA unique name for the CIDR collection.
arnstringThe Amazon resource name (ARN) to uniquely identify the AWS resource.
locationsarrayA complex type that contains information about the list of CIDR locations.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cidr_collection resource, the following permissions are required: + +### Read +
+route53:ListCidrCollections,
+route53:ListCidrBlocks
+ +### Update +
+route53:ChangeCidrCollection
+ +### Delete +
+route53:DeleteCidrCollection,
+route53:ChangeCidrCollection
+ + +## Example +```sql +SELECT +region, +id, +name, +arn, +locations +FROM awscc.route53.cidr_collection +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md b/docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md new file mode 100644 index 0000000000..b01e7aea67 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md @@ -0,0 +1,60 @@ +--- +title: cidr_collections +hide_title: false +hide_table_of_contents: false +keywords: + - cidr_collections + - 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 +--- +Retrieves a list of cidr_collections in a region + +## Overview + + + + + +
Namecidr_collections
TypeResource
Descriptioncidr_collections
Idawscc.route53.cidr_collections
+ +## Fields + + + + + +
NameDatatypeDescription
idstringUUID of the CIDR collection.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cidr_collections resource, the following permissions are required: + +### Create +
+route53:CreateCidrCollection,
+route53:ChangeCidrCollection
+ +### List +
+route53:ListCidrCollections,
+route53:ListCidrBlocks
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53.cidr_collections + +``` diff --git a/docs/awscc-docs/providers/awscc/route53/dnssec/index.md b/docs/awscc-docs/providers/awscc/route53/dnssec/index.md new file mode 100644 index 0000000000..b6055ef234 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/dnssec/index.md @@ -0,0 +1,63 @@ +--- +title: dnssec +hide_title: false +hide_table_of_contents: false +keywords: + - dnssec + - 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 +--- +Gets an individual dnssec resource + +## Overview + + + + + +
Namednssec
TypeResource
Descriptiondnssec
Idawscc.route53.dnssec
+ +## Fields + + + + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dnssec resource, the following permissions are required: + +### Read +
+route53:GetDNSSEC
+ +### Delete +
+route53:GetDNSSEC,
+route53:DisableHostedZoneDNSSEC,
+kms:DescribeKey,
+kms:GetPublicKey,
+kms:Sign,
+kms:CreateGrant
+ + +## Example +```sql +SELECT +region, +hosted_zone_id +FROM awscc.route53.dnssec +WHERE data__Identifier = '<HostedZoneId>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53/dnssecs/index.md b/docs/awscc-docs/providers/awscc/route53/dnssecs/index.md new file mode 100644 index 0000000000..d61c33ff4a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/dnssecs/index.md @@ -0,0 +1,64 @@ +--- +title: dnssecs +hide_title: false +hide_table_of_contents: false +keywords: + - dnssecs + - 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 +--- +Retrieves a list of dnssecs in a region + +## Overview + + + + + +
Namednssecs
TypeResource
Descriptiondnssecs
Idawscc.route53.dnssecs
+ +## Fields + + + + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dnssecs resource, the following permissions are required: + +### Create +
+route53:GetDNSSEC,
+route53:EnableHostedZoneDNSSEC,
+kms:DescribeKey,
+kms:GetPublicKey,
+kms:Sign,
+kms:CreateGrant
+ +### List +
+route53:GetDNSSEC,
+route53:ListHostedZones
+ + +## Example +```sql +SELECT +region, +hosted_zone_id +FROM awscc.route53.dnssecs + +``` diff --git a/docs/awscc-docs/providers/awscc/route53/health_check/index.md b/docs/awscc-docs/providers/awscc/route53/health_check/index.md new file mode 100644 index 0000000000..938d1f2c32 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/health_check/index.md @@ -0,0 +1,70 @@ +--- +title: health_check +hide_title: false +hide_table_of_contents: false +keywords: + - health_check + - 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 +--- +Gets an individual health_check resource + +## Overview + + + + + +
Namehealth_check
TypeResource
Descriptionhealth_check
Idawscc.route53.health_check
+ +## Fields + + + + + + + +
NameDatatypeDescription
health_check_idstring
health_check_configobjectA complex type that contains information about the health check.
health_check_tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the health_check resource, the following permissions are required: + +### Read +
+route53:GetHealthCheck,
+route53:ListTagsForResource
+ +### Update +
+route53:UpdateHealthCheck,
+route53:ChangeTagsForResource,
+route53:ListTagsForResource,
+cloudwatch:DescribeAlarms
+ +### Delete +
+route53:DeleteHealthCheck
+ + +## Example +```sql +SELECT +region, +health_check_id, +health_check_config, +health_check_tags +FROM awscc.route53.health_check +WHERE data__Identifier = '<HealthCheckId>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53/health_checks/index.md b/docs/awscc-docs/providers/awscc/route53/health_checks/index.md new file mode 100644 index 0000000000..acb86ceec3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/health_checks/index.md @@ -0,0 +1,62 @@ +--- +title: health_checks +hide_title: false +hide_table_of_contents: false +keywords: + - health_checks + - 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 +--- +Retrieves a list of health_checks in a region + +## Overview + + + + + +
Namehealth_checks
TypeResource
Descriptionhealth_checks
Idawscc.route53.health_checks
+ +## Fields + + + + + +
NameDatatypeDescription
health_check_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the health_checks resource, the following permissions are required: + +### Create +
+route53:CreateHealthCheck,
+route53:ChangeTagsForResource,
+cloudwatch:DescribeAlarms,
+route53-recovery-control-config:DescribeRoutingControl
+ +### List +
+route53:ListHealthChecks,
+route53:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +health_check_id +FROM awscc.route53.health_checks + +``` diff --git a/docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md b/docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md new file mode 100644 index 0000000000..676604691e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md @@ -0,0 +1,87 @@ +--- +title: hosted_zone +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_zone + - 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 +--- +Gets an individual hosted_zone resource + +## Overview + + + + + +
Namehosted_zone
TypeResource
Descriptionhosted_zone
Idawscc.route53.hosted_zone
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
hosted_zone_configobject
hosted_zone_tagsarrayAdds, edits, or deletes tags for a health check or a hosted zone.<br/><br/>For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
namestringThe 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.<br/><br/>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.
query_logging_configobject
v_pcsarrayA complex type that contains information about the VPCs that are associated with the specified hosted zone.
name_serversarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hosted_zone resource, the following permissions are required: + +### Read +
+route53:GetHostedZone,
+route53:ListTagsForResource,
+route53:ListQueryLoggingConfigs
+ +### Update +
+route53:GetChange,
+route53:ListTagsForResource,
+route53:UpdateHostedZoneComment,
+route53:ChangeTagsForResource,
+route53:AssociateVPCWithHostedZone,
+route53:DisassociateVPCFromHostedZone,
+route53:CreateQueryLoggingConfig,
+route53:DeleteQueryLoggingConfig,
+ec2:DescribeVpcs
+ +### Delete +
+route53:DeleteHostedZone,
+route53:DeleteQueryLoggingConfig,
+route53:ListQueryLoggingConfigs,
+route53:GetChange
+ + +## Example +```sql +SELECT +region, +id, +hosted_zone_config, +hosted_zone_tags, +name, +query_logging_config, +v_pcs, +name_servers +FROM awscc.route53.hosted_zone +WHERE data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md b/docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md new file mode 100644 index 0000000000..62c60cf717 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md @@ -0,0 +1,67 @@ +--- +title: hosted_zones +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_zones + - 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 +--- +Retrieves a list of hosted_zones in a region + +## Overview + + + + + +
Namehosted_zones
TypeResource
Descriptionhosted_zones
Idawscc.route53.hosted_zones
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hosted_zones resource, the following permissions are required: + +### Create +
+route53:CreateHostedZone,
+route53:CreateQueryLoggingConfig,
+route53:ChangeTagsForResource,
+route53:GetChange,
+route53:AssociateVPCWithHostedZone,
+ec2:DescribeVpcs
+ +### List +
+route53:GetHostedZone,
+route53:ListHostedZones,
+route53:ListHostedZonesByName,
+route53:ListQueryLoggingConfigs,
+route53:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53.hosted_zones + +``` diff --git a/docs/awscc-docs/providers/awscc/route53/index.md b/docs/awscc-docs/providers/awscc/route53/index.md new file mode 100644 index 0000000000..3796e6832c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/index.md @@ -0,0 +1,47 @@ +--- +title: route53 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The route53 service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+cidr_collection
+cidr_collections
+dnssec
+dnssecs
+health_check +
+
+health_checks
+hosted_zone
+hosted_zones
+key_signing_key
+key_signing_keys +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/route53/key_signing_key/index.md b/docs/awscc-docs/providers/awscc/route53/key_signing_key/index.md new file mode 100644 index 0000000000..acf5bdf329 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/key_signing_key/index.md @@ -0,0 +1,80 @@ +--- +title: key_signing_key +hide_title: false +hide_table_of_contents: false +keywords: + - key_signing_key + - 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 +--- +Gets an individual key_signing_key resource + +## Overview + + + + + +
Namekey_signing_key
TypeResource
Descriptionkey_signing_key
Idawscc.route53.key_signing_key
+ +## Fields + + + + + + + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
statusstringA string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE.
namestringAn alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
key_management_service_arnstringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the key_signing_key resource, the following permissions are required: + +### Read +
+route53:GetDNSSEC
+ +### Update +
+route53:GetDNSSEC,
+route53:ActivateKeySigningKey,
+route53:DeactivateKeySigningKey,
+kms:DescribeKey,
+kms:GetPublicKey,
+kms:Sign,
+kms:CreateGrant
+ +### Delete +
+route53:DeactivateKeySigningKey,
+route53:DeleteKeySigningKey,
+kms:DescribeKey,
+kms:GetPublicKey,
+kms:Sign,
+kms:CreateGrant
+ + +## Example +```sql +SELECT +region, +hosted_zone_id, +status, +name, +key_management_service_arn +FROM awscc.route53.key_signing_key +WHERE data__Identifier = '<HostedZoneId>' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53/key_signing_keys/index.md b/docs/awscc-docs/providers/awscc/route53/key_signing_keys/index.md new file mode 100644 index 0000000000..68427da01e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53/key_signing_keys/index.md @@ -0,0 +1,65 @@ +--- +title: key_signing_keys +hide_title: false +hide_table_of_contents: false +keywords: + - key_signing_keys + - 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 +--- +Retrieves a list of key_signing_keys in a region + +## Overview + + + + + +
Namekey_signing_keys
TypeResource
Descriptionkey_signing_keys
Idawscc.route53.key_signing_keys
+ +## Fields + + + + + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
namestringAn alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the key_signing_keys resource, the following permissions are required: + +### Create +
+route53:CreateKeySigningKey,
+kms:DescribeKey,
+kms:GetPublicKey,
+kms:Sign,
+kms:CreateGrant
+ +### List +
+route53:GetDNSSEC,
+route53:ListHostedZones
+ + +## Example +```sql +SELECT +region, +hosted_zone_id, +name +FROM awscc.route53.key_signing_keys + +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md new file mode 100644 index 0000000000..01e9215625 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md @@ -0,0 +1,69 @@ +--- +title: cluster +hide_title: false +hide_table_of_contents: false +keywords: + - cluster + - 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 +--- +Gets an individual cluster resource + +## Overview + + + + + +
Namecluster
TypeResource
Descriptioncluster
Idawscc.route53recoverycontrol.cluster
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringName of a Cluster. You can use any non-white space character in the name
cluster_arnstringThe Amazon Resource Name (ARN) of the cluster.
statusstringDeployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
cluster_endpointsarrayEndpoints for the cluster.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +
+route53-recovery-control-config:DescribeCluster,
+route53-recovery-control-config:ListTagsForResource
+ +### Delete +
+route53-recovery-control-config:DescribeCluster,
+route53-recovery-control-config:DeleteCluster
+ + +## Example +```sql +SELECT +region, +name, +cluster_arn, +status, +cluster_endpoints, +tags +FROM awscc.route53recoverycontrol.cluster +WHERE region = 'us-east-1' +AND data__Identifier = '<ClusterArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md new file mode 100644 index 0000000000..5dd025ea2c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md @@ -0,0 +1,61 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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 +--- +Retrieves a list of clusters in a region + +## Overview + + + + + +
Nameclusters
TypeResource
Descriptionclusters
Idawscc.route53recoverycontrol.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstringThe Amazon Resource Name (ARN) of the cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +
+route53-recovery-control-config:CreateCluster,
+route53-recovery-control-config:DescribeCluster,
+route53-recovery-control-config:ListTagsForResource,
+route53-recovery-control-config:TagResource
+ +### List +
+route53-recovery-control-config:ListClusters
+ + +## Example +```sql +SELECT +region, +cluster_arn +FROM awscc.route53recoverycontrol.clusters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md new file mode 100644 index 0000000000..69e03b0f1d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md @@ -0,0 +1,81 @@ +--- +title: control_panel +hide_title: false +hide_table_of_contents: false +keywords: + - control_panel + - 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 +--- +Gets an individual control_panel resource + +## Overview + + + + + +
Namecontrol_panel
TypeResource
Descriptioncontrol_panel
Idawscc.route53recoverycontrol.control_panel
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
cluster_arnstringCluster to associate with the Control Panel
control_panel_arnstringThe Amazon Resource Name (ARN) of the cluster.
namestringThe name of the control panel. You can use any non-white space character in the name.
statusstringThe deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
default_control_panelbooleanA 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.
routing_control_countintegerCount of associated routing controls
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the control_panel resource, the following permissions are required: + +### Read +
+route53-recovery-control-config:DescribeControlPanel,
+route53-recovery-control-config:ListTagsForResource
+ +### Update +
+route53-recovery-control-config:UpdateControlPanel,
+route53-recovery-control-config:DescribeControlPanel,
+route53-recovery-control-config:ListTagsForResource,
+route53-recovery-control-config:TagResource,
+route53-recovery-control-config:UntagResource
+ +### Delete +
+route53-recovery-control-config:DeleteControlPanel,
+route53-recovery-control-config:DescribeControlPanel
+ + +## Example +```sql +SELECT +region, +cluster_arn, +control_panel_arn, +name, +status, +default_control_panel, +routing_control_count, +tags +FROM awscc.route53recoverycontrol.control_panel +WHERE region = 'us-east-1' +AND data__Identifier = '<ControlPanelArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md new file mode 100644 index 0000000000..02e7296d68 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md @@ -0,0 +1,62 @@ +--- +title: control_panels +hide_title: false +hide_table_of_contents: false +keywords: + - control_panels + - 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 +--- +Retrieves a list of control_panels in a region + +## Overview + + + + + +
Namecontrol_panels
TypeResource
Descriptioncontrol_panels
Idawscc.route53recoverycontrol.control_panels
+ +## Fields + + + + + +
NameDatatypeDescription
control_panel_arnstringThe Amazon Resource Name (ARN) of the cluster.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the control_panels resource, the following permissions are required: + +### Create +
+route53-recovery-control-config:CreateControlPanel,
+route53-recovery-control-config:DescribeCluster,
+route53-recovery-control-config:DescribeControlPanel,
+route53-recovery-control-config:ListTagsForResource,
+route53-recovery-control-config:TagResource
+ +### List +
+route53-recovery-control-config:ListControlPanels
+ + +## Example +```sql +SELECT +region, +control_panel_arn +FROM awscc.route53recoverycontrol.control_panels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md new file mode 100644 index 0000000000..016f43a324 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md @@ -0,0 +1,45 @@ +--- +title: route53recoverycontrol +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The route53recoverycontrol service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+cluster
+clusters
+control_panel
+control_panels +
+
+routing_control
+routing_controls
+safety_rule
+safety_rules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_control/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_control/index.md new file mode 100644 index 0000000000..b20f69af15 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_control/index.md @@ -0,0 +1,74 @@ +--- +title: routing_control +hide_title: false +hide_table_of_contents: false +keywords: + - routing_control + - 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 +--- +Gets an individual routing_control resource + +## Overview + + + + + +
Namerouting_control
TypeResource
Descriptionrouting_control
Idawscc.route53recoverycontrol.routing_control
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
routing_control_arnstringThe Amazon Resource Name (ARN) of the routing control.
control_panel_arnstringThe Amazon Resource Name (ARN) of the control panel.
namestringThe name of the routing control. You can use any non-white space character in the name.
statusstringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
cluster_arnstringArn associated with Control Panel
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the routing_control resource, the following permissions are required: + +### Read +
+route53-recovery-control-config:DescribeRoutingControl
+ +### Update +
+route53-recovery-control-config:UpdateRoutingControl,
+route53-recovery-control-config:DescribeRoutingControl,
+route53-recovery-control-config:DescribeControlPanel
+ +### Delete +
+route53-recovery-control-config:DescribeRoutingControl,
+route53-recovery-control-config:DeleteRoutingControl
+ + +## Example +```sql +SELECT +region, +routing_control_arn, +control_panel_arn, +name, +status, +cluster_arn +FROM awscc.route53recoverycontrol.routing_control +WHERE region = 'us-east-1' +AND data__Identifier = '<RoutingControlArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md new file mode 100644 index 0000000000..1f83666c1f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md @@ -0,0 +1,61 @@ +--- +title: routing_controls +hide_title: false +hide_table_of_contents: false +keywords: + - routing_controls + - 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 +--- +Retrieves a list of routing_controls in a region + +## Overview + + + + + +
Namerouting_controls
TypeResource
Descriptionrouting_controls
Idawscc.route53recoverycontrol.routing_controls
+ +## Fields + + + + + +
NameDatatypeDescription
routing_control_arnstringThe Amazon Resource Name (ARN) of the routing control.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the routing_controls resource, the following permissions are required: + +### Create +
+route53-recovery-control-config:CreateRoutingControl,
+route53-recovery-control-config:DescribeRoutingControl,
+route53-recovery-control-config:DescribeControlPanel,
+route53-recovery-control-config:DescribeCluster
+ +### List +
+route53-recovery-control-config:ListRoutingControls
+ + +## Example +```sql +SELECT +region, +routing_control_arn +FROM awscc.route53recoverycontrol.routing_controls +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md new file mode 100644 index 0000000000..5e668ecf69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md @@ -0,0 +1,83 @@ +--- +title: safety_rule +hide_title: false +hide_table_of_contents: false +keywords: + - safety_rule + - 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 +--- +Gets an individual safety_rule resource + +## Overview + + + + + +
Namesafety_rule
TypeResource
Descriptionsafety_rule
Idawscc.route53recoverycontrol.safety_rule
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
assertion_ruleobject
gating_ruleobject
namestring
safety_rule_arnstringThe Amazon Resource Name (ARN) of the safety rule.
control_panel_arnstringThe Amazon Resource Name (ARN) of the control panel.
statusstringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
rule_configobject
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the safety_rule resource, the following permissions are required: + +### Read +
+route53-recovery-control-config:DescribeSafetyRule,
+route53-recovery-control-config:ListTagsForResource
+ +### Update +
+route53-recovery-control-config:UpdateSafetyRule,
+route53-recovery-control-config:DescribeSafetyRule,
+route53-recovery-control-config:ListTagsForResource,
+route53-recovery-control-config:TagResource,
+route53-recovery-control-config:UntagResource
+ +### Delete +
+route53-recovery-control-config:DescribeSafetyRule,
+route53-recovery-control-config:DeleteSafetyRule
+ + +## Example +```sql +SELECT +region, +assertion_rule, +gating_rule, +name, +safety_rule_arn, +control_panel_arn, +status, +rule_config, +tags +FROM awscc.route53recoverycontrol.safety_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<SafetyRuleArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md new file mode 100644 index 0000000000..b8808e742a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md @@ -0,0 +1,63 @@ +--- +title: safety_rules +hide_title: false +hide_table_of_contents: false +keywords: + - safety_rules + - 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 +--- +Retrieves a list of safety_rules in a region + +## Overview + + + + + +
Namesafety_rules
TypeResource
Descriptionsafety_rules
Idawscc.route53recoverycontrol.safety_rules
+ +## Fields + + + + + +
NameDatatypeDescription
safety_rule_arnstringThe Amazon Resource Name (ARN) of the safety rule.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the safety_rules resource, the following permissions are required: + +### Create +
+route53-recovery-control-config:CreateSafetyRule,
+route53-recovery-control-config:DescribeSafetyRule,
+route53-recovery-control-config:DescribeControlPanel,
+route53-recovery-control-config:DescribeRoutingControl,
+route53-recovery-control-config:ListTagsForResource,
+route53-recovery-control-config:TagResource
+ +### List +
+route53-recovery-control-config:ListSafetyRules
+ + +## Example +```sql +SELECT +region, +safety_rule_arn +FROM awscc.route53recoverycontrol.safety_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md new file mode 100644 index 0000000000..df0398e70f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md @@ -0,0 +1,77 @@ +--- +title: cell +hide_title: false +hide_table_of_contents: false +keywords: + - cell + - 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 +--- +Gets an individual cell resource + +## Overview + + + + + +
Namecell
TypeResource
Descriptioncell
Idawscc.route53recoveryreadiness.cell
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
cell_namestringThe name of the cell to create.
cell_arnstringThe Amazon Resource Name (ARN) of the cell.
cellsarrayA list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.
parent_readiness_scopesarrayThe 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.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cell resource, the following permissions are required: + +### Read +
+route53-recovery-readiness:GetCell,
+route53-recovery-readiness:ListTagsForResources
+ +### Update +
+route53-recovery-readiness:GetCell,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource,
+route53-recovery-readiness:UntagResource,
+route53-recovery-readiness:UpdateCell
+ +### Delete +
+route53-recovery-readiness:DeleteCell,
+route53-recovery-readiness:GetCell
+ + +## Example +```sql +SELECT +region, +cell_name, +cell_arn, +cells, +parent_readiness_scopes, +tags +FROM awscc.route53recoveryreadiness.cell +WHERE region = 'us-east-1' +AND data__Identifier = '<CellName>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md new file mode 100644 index 0000000000..74c754f15b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md @@ -0,0 +1,61 @@ +--- +title: cells +hide_title: false +hide_table_of_contents: false +keywords: + - cells + - 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 +--- +Retrieves a list of cells in a region + +## Overview + + + + + +
Namecells
TypeResource
Descriptioncells
Idawscc.route53recoveryreadiness.cells
+ +## Fields + + + + + +
NameDatatypeDescription
cell_namestringThe name of the cell to create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cells resource, the following permissions are required: + +### Create +
+route53-recovery-readiness:CreateCell,
+route53-recovery-readiness:GetCell,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource
+ +### List +
+route53-recovery-readiness:ListCells
+ + +## Example +```sql +SELECT +region, +cell_name +FROM awscc.route53recoveryreadiness.cells +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md new file mode 100644 index 0000000000..67bc0d77d4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md @@ -0,0 +1,45 @@ +--- +title: route53recoveryreadiness +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The route53recoveryreadiness service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+cell
+cells
+readiness_check
+readiness_checks +
+
+recovery_group
+recovery_groups
+resource_set
+resource_sets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_check/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_check/index.md new file mode 100644 index 0000000000..0e9fbd2976 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_check/index.md @@ -0,0 +1,76 @@ +--- +title: readiness_check +hide_title: false +hide_table_of_contents: false +keywords: + - readiness_check + - 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 +--- +Gets an individual readiness_check resource + +## Overview + + + + + +
Namereadiness_check
TypeResource
Descriptionreadiness_check
Idawscc.route53recoveryreadiness.readiness_check
+ +## Fields + + + + + + + + +
NameDatatypeDescription
resource_set_namestringThe name of the resource set to check.
readiness_check_namestringName of the ReadinessCheck to create.
readiness_check_arnstringThe Amazon Resource Name (ARN) of the readiness check.
tagsarrayA collection of tags associated with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the readiness_check resource, the following permissions are required: + +### Read +
+route53-recovery-readiness:GetReadinessCheck,
+route53-recovery-readiness:ListTagsForResources
+ +### Update +
+route53-recovery-readiness:UpdateReadinessCheck,
+route53-recovery-readiness:GetResourceSet,
+route53-recovery-readiness:GetReadinessCheck,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource,
+route53-recovery-readiness:UntagResource
+ +### Delete +
+route53-recovery-readiness:DeleteReadinessCheck,
+route53-recovery-readiness:GetReadinessCheck
+ + +## Example +```sql +SELECT +region, +resource_set_name, +readiness_check_name, +readiness_check_arn, +tags +FROM awscc.route53recoveryreadiness.readiness_check +WHERE region = 'us-east-1' +AND data__Identifier = '<ReadinessCheckName>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md new file mode 100644 index 0000000000..b171ed67be --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md @@ -0,0 +1,63 @@ +--- +title: readiness_checks +hide_title: false +hide_table_of_contents: false +keywords: + - readiness_checks + - 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 +--- +Retrieves a list of readiness_checks in a region + +## Overview + + + + + +
Namereadiness_checks
TypeResource
Descriptionreadiness_checks
Idawscc.route53recoveryreadiness.readiness_checks
+ +## Fields + + + + + +
NameDatatypeDescription
readiness_check_namestringName of the ReadinessCheck to create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the readiness_checks resource, the following permissions are required: + +### Create +
+route53-recovery-readiness:CreateReadinessCheck,
+route53-recovery-readiness:GetResourceSet,
+route53-recovery-readiness:GetReadinessCheck,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource
+ +### List +
+route53-recovery-readiness:ListReadinessChecks,
+route53-recovery-readiness:GetReadinessChecks
+ + +## Example +```sql +SELECT +region, +readiness_check_name +FROM awscc.route53recoveryreadiness.readiness_checks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md new file mode 100644 index 0000000000..83598aa80c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md @@ -0,0 +1,76 @@ +--- +title: recovery_group +hide_title: false +hide_table_of_contents: false +keywords: + - recovery_group + - 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 +--- +Gets an individual recovery_group resource + +## Overview + + + + + +
Namerecovery_group
TypeResource
Descriptionrecovery_group
Idawscc.route53recoveryreadiness.recovery_group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
recovery_group_namestringThe name of the recovery group to create.
cellsarrayA list of the cell Amazon Resource Names (ARNs) in the recovery group.
recovery_group_arnstringA collection of tags associated with a resource.
tagsarrayA collection of tags associated with a resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the recovery_group resource, the following permissions are required: + +### Read +
+route53-recovery-readiness:GetRecoveryGroup,
+route53-recovery-readiness:ListTagsForResources
+ +### Update +
+route53-recovery-readiness:UpdateRecoveryGroup,
+route53-recovery-readiness:GetRecoveryGroup,
+route53-recovery-readiness:GetCell,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource,
+route53-recovery-readiness:UntagResource
+ +### Delete +
+route53-recovery-readiness:DeleteRecoveryGroup,
+route53-recovery-readiness:GetRecoveryGroup
+ + +## Example +```sql +SELECT +region, +recovery_group_name, +cells, +recovery_group_arn, +tags +FROM awscc.route53recoveryreadiness.recovery_group +WHERE region = 'us-east-1' +AND data__Identifier = '<RecoveryGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md new file mode 100644 index 0000000000..314c78e537 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md @@ -0,0 +1,62 @@ +--- +title: recovery_groups +hide_title: false +hide_table_of_contents: false +keywords: + - recovery_groups + - 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 +--- +Retrieves a list of recovery_groups in a region + +## Overview + + + + + +
Namerecovery_groups
TypeResource
Descriptionrecovery_groups
Idawscc.route53recoveryreadiness.recovery_groups
+ +## Fields + + + + + +
NameDatatypeDescription
recovery_group_namestringThe name of the recovery group to create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the recovery_groups resource, the following permissions are required: + +### Create +
+route53-recovery-readiness:CreateRecoveryGroup,
+route53-recovery-readiness:GetRecoveryGroup,
+route53-recovery-readiness:GetCell,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource
+ +### List +
+route53-recovery-readiness:ListRecoveryGroups
+ + +## Example +```sql +SELECT +region, +recovery_group_name +FROM awscc.route53recoveryreadiness.recovery_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md new file mode 100644 index 0000000000..3193b46656 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md @@ -0,0 +1,79 @@ +--- +title: resource_set +hide_title: false +hide_table_of_contents: false +keywords: + - resource_set + - 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 +--- +Gets an individual resource_set resource + +## Overview + + + + + +
Nameresource_set
TypeResource
Descriptionresource_set
Idawscc.route53recoveryreadiness.resource_set
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
resource_set_namestringThe name of the resource set to create.
resourcesarrayA list of resource objects in the resource set.
resource_set_arnstringThe Amazon Resource Name (ARN) of the resource set.
resource_set_typestringThe resource type of the resources in the resource set. Enter one of the following values for resource type: <br/><br/>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
tagsarrayA tag to associate with the parameters for a resource set.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_set resource, the following permissions are required: + +### Read +
+route53-recovery-readiness:GetResourceSet,
+route53-recovery-readiness:ListTagsForResources
+ +### Update +
+route53-recovery-readiness:UpdateResourceSet,
+route53-recovery-readiness:GetResourceSet,
+route53-recovery-readiness:GetRecoveryGroup,
+route53-recovery-readiness:GetCell,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource,
+route53-recovery-readiness:UntagResource
+ +### Delete +
+route53-recovery-readiness:DeleteResourceSet,
+route53-recovery-readiness:GetResourceSet
+ + +## Example +```sql +SELECT +region, +resource_set_name, +resources, +resource_set_arn, +resource_set_type, +tags +FROM awscc.route53recoveryreadiness.resource_set +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceSetName>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md new file mode 100644 index 0000000000..daf3c421de --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md @@ -0,0 +1,63 @@ +--- +title: resource_sets +hide_title: false +hide_table_of_contents: false +keywords: + - resource_sets + - 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 +--- +Retrieves a list of resource_sets in a region + +## Overview + + + + + +
Nameresource_sets
TypeResource
Descriptionresource_sets
Idawscc.route53recoveryreadiness.resource_sets
+ +## Fields + + + + + +
NameDatatypeDescription
resource_set_namestringThe name of the resource set to create.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_sets resource, the following permissions are required: + +### Create +
+route53-recovery-readiness:CreateResourceSet,
+route53-recovery-readiness:GetResourceSet,
+route53-recovery-readiness:GetRecoveryGroup,
+route53-recovery-readiness:GetCell,
+route53-recovery-readiness:ListTagsForResources,
+route53-recovery-readiness:TagResource
+ +### List +
+route53-recovery-readiness:ListResourceSets
+ + +## Example +```sql +SELECT +region, +resource_set_name +FROM awscc.route53recoveryreadiness.resource_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_list/index.md b/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_list/index.md new file mode 100644 index 0000000000..22a8e37be5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_list/index.md @@ -0,0 +1,102 @@ +--- +title: firewall_domain_list +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_domain_list + - 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 +--- +Gets an individual firewall_domain_list resource + +## Overview + + + + + +
Namefirewall_domain_list
TypeResource
Descriptionfirewall_domain_list
Idawscc.route53resolver.firewall_domain_list
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringResourceId
arnstringArn
namestringFirewallDomainListName
domain_countintegerCount
statusstringResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_messagestringFirewallDomainListAssociationStatus
managed_owner_namestringServicePrincipal
creator_request_idstringThe id of the creator request.
creation_timestringRfc3339TimeString
modification_timestringRfc3339TimeString
domainsarray
domain_file_urlstringS3 URL to import domains from.
tagsarrayTags
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_domain_list resource, the following permissions are required: + +### Read +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### Delete +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### Update +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ + +## Example +```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, +tags +FROM awscc.route53resolver.firewall_domain_list +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_lists/index.md b/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_lists/index.md new file mode 100644 index 0000000000..f90efd3762 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_lists/index.md @@ -0,0 +1,68 @@ +--- +title: firewall_domain_lists +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_domain_lists + - 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 +--- +Retrieves a list of firewall_domain_lists in a region + +## Overview + + + + + +
Namefirewall_domain_lists
TypeResource
Descriptionfirewall_domain_lists
Idawscc.route53resolver.firewall_domain_lists
+ +## Fields + + + + + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_domain_lists resource, the following permissions are required: + +### Create +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### List +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53resolver.firewall_domain_lists +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group/index.md b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group/index.md new file mode 100644 index 0000000000..526dbfb5cc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group/index.md @@ -0,0 +1,102 @@ +--- +title: firewall_rule_group +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group + - 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 +--- +Gets an individual firewall_rule_group resource + +## Overview + + + + + +
Namefirewall_rule_group
TypeResource
Descriptionfirewall_rule_group
Idawscc.route53resolver.firewall_rule_group
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringResourceId
arnstringArn
namestringFirewallRuleGroupName
rule_countintegerCount
statusstringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_messagestringFirewallRuleGroupStatus
owner_idstringAccountId
share_statusstringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
creator_request_idstringThe id of the creator request.
creation_timestringRfc3339TimeString
modification_timestringRfc3339TimeString
firewall_rulesarrayFirewallRules
tagsarrayTags
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_rule_group resource, the following permissions are required: + +### Read +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### Delete +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### Update +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ + +## Example +```sql +SELECT +region, +id, +arn, +name, +rule_count, +status, +status_message, +owner_id, +share_status, +creator_request_id, +creation_time, +modification_time, +firewall_rules, +tags +FROM awscc.route53resolver.firewall_rule_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_association/index.md b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_association/index.md new file mode 100644 index 0000000000..2a0284b567 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_association/index.md @@ -0,0 +1,104 @@ +--- +title: firewall_rule_group_association +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_association + - 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 +--- +Gets an individual firewall_rule_group_association resource + +## Overview + + + + + +
Namefirewall_rule_group_association
TypeResource
Descriptionfirewall_rule_group_association
Idawscc.route53resolver.firewall_rule_group_association
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringId
arnstringArn
firewall_rule_group_idstringFirewallRuleGroupId
vpc_idstringVpcId
namestringFirewallRuleGroupAssociationName
priorityintegerPriority
mutation_protectionstringMutationProtectionStatus
managed_owner_namestringServicePrincipal
statusstringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_messagestringFirewallDomainListAssociationStatus
creator_request_idstringThe id of the creator request.
creation_timestringRfc3339TimeString
modification_timestringRfc3339TimeString
tagsarrayTags
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_rule_group_association resource, the following permissions are required: + +### Read +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### Delete +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### Update +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ + +## Example +```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, +tags +FROM awscc.route53resolver.firewall_rule_group_association +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_associations/index.md b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_associations/index.md new file mode 100644 index 0000000000..563b5e33df --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_associations/index.md @@ -0,0 +1,68 @@ +--- +title: firewall_rule_group_associations +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_associations + - 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 +--- +Retrieves a list of firewall_rule_group_associations in a region + +## Overview + + + + + +
Namefirewall_rule_group_associations
TypeResource
Descriptionfirewall_rule_group_associations
Idawscc.route53resolver.firewall_rule_group_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_rule_group_associations resource, the following permissions are required: + +### Create +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### List +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53resolver.firewall_rule_group_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_groups/index.md b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_groups/index.md new file mode 100644 index 0000000000..144fa9bed2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_groups/index.md @@ -0,0 +1,68 @@ +--- +title: firewall_rule_groups +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_groups + - 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 +--- +Retrieves a list of firewall_rule_groups in a region + +## Overview + + + + + +
Namefirewall_rule_groups
TypeResource
Descriptionfirewall_rule_groups
Idawscc.route53resolver.firewall_rule_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the firewall_rule_groups resource, the following permissions are required: + +### Create +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ +### List +
+route53resolver:*,
+ec2:*,
+logs:*,
+iam:*,
+lambda:*,
+s3:*
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53resolver.firewall_rule_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/index.md b/docs/awscc-docs/providers/awscc/route53resolver/index.md new file mode 100644 index 0000000000..575d9a3928 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/index.md @@ -0,0 +1,57 @@ +--- +title: route53resolver +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The route53resolver service documentation. + +:::info Service Summary + +
+
+total resources: 20
+total selectable resources: 20
+total methods: 20
+
+
+ +::: + +## Resources +
+
+firewall_domain_list
+firewall_domain_lists
+firewall_rule_group
+firewall_rule_group_association
+firewall_rule_group_associations
+firewall_rule_groups
+outpost_resolver
+outpost_resolvers
+resolver_config
+resolver_configs +
+
+resolver_query_logging_config
+resolver_query_logging_config_association
+resolver_query_logging_config_associations
+resolver_query_logging_configs
+resolver_rule
+resolver_rule_association
+resolver_rule_associations
+resolver_rules
+resolverdnssec_config
+resolverdnssec_configs +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolver/index.md b/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolver/index.md new file mode 100644 index 0000000000..68e9336572 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolver/index.md @@ -0,0 +1,93 @@ +--- +title: outpost_resolver +hide_title: false +hide_table_of_contents: false +keywords: + - outpost_resolver + - 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 +--- +Gets an individual outpost_resolver resource + +## Overview + + + + + +
Nameoutpost_resolver
TypeResource
Descriptionoutpost_resolver
Idawscc.route53resolver.outpost_resolver
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringId
creator_request_idstringThe id of the creator request.
namestringThe OutpostResolver name.
arnstringThe OutpostResolver ARN.
outpost_arnstringThe Outpost ARN.
preferred_instance_typestringThe OutpostResolver instance type.
statusstringThe OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.
status_messagestringThe OutpostResolver status message.
instance_countintegerThe number of OutpostResolvers.
creation_timestringThe OutpostResolver creation time
modification_timestringThe OutpostResolver last modified time
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the outpost_resolver resource, the following permissions are required: + +### Read +
+route53resolver:GetOutpostResolver,
+route53resolver:ListTagsForResource
+ +### Update +
+route53resolver:UpdateOutpostResolver,
+route53resolver:GetOutpostResolver,
+route53resolver:UntagResource,
+route53resolver:TagResource,
+route53resolver:ListTagsForResource
+ +### Delete +
+route53resolver:DeleteOutpostResolver,
+route53resolver:GetOutpostResolver,
+route53resolver:ListOutpostResolvers,
+route53resolver:ListResolverEndpoints
+ + +## Example +```sql +SELECT +region, +id, +creator_request_id, +name, +arn, +outpost_arn, +preferred_instance_type, +status, +status_message, +instance_count, +creation_time, +modification_time, +tags +FROM awscc.route53resolver.outpost_resolver +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md b/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md new file mode 100644 index 0000000000..cc25fec09b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md @@ -0,0 +1,62 @@ +--- +title: outpost_resolvers +hide_title: false +hide_table_of_contents: false +keywords: + - outpost_resolvers + - 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 +--- +Retrieves a list of outpost_resolvers in a region + +## Overview + + + + + +
Nameoutpost_resolvers
TypeResource
Descriptionoutpost_resolvers
Idawscc.route53resolver.outpost_resolvers
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the outpost_resolvers resource, the following permissions are required: + +### Create +
+route53resolver:CreateOutpostResolver,
+route53resolver:GetOutpostResolver,
+route53resolver:ListTagsForResource,
+outposts:GetOutpost
+ +### List +
+route53resolver:ListOutpostResolvers,
+route53resolver:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53resolver.outpost_resolvers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md new file mode 100644 index 0000000000..3f707f0e7b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md @@ -0,0 +1,70 @@ +--- +title: resolver_config +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_config + - 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 +--- +Gets an individual resolver_config resource + +## Overview + + + + + +
Nameresolver_config
TypeResource
Descriptionresolver_config
Idawscc.route53resolver.resolver_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstringId
owner_idstringAccountId
resource_idstringResourceId
autodefined_reversestringResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
autodefined_reverse_flagstringRepresents 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).
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_config resource, the following permissions are required: + +### Read +
+route53resolver:GetResolverConfig,
+ec2:DescribeVpcs
+ +### Delete +
+route53resolver:UpdateResolverConfig,
+route53resolver:ListResolverConfigs,
+ec2:DescribeVpcs
+ + +## Example +```sql +SELECT +region, +id, +owner_id, +resource_id, +autodefined_reverse, +autodefined_reverse_flag +FROM awscc.route53resolver.resolver_config +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md new file mode 100644 index 0000000000..1b17358c1c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md @@ -0,0 +1,61 @@ +--- +title: resolver_configs +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_configs + - 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 +--- +Retrieves a list of resolver_configs in a region + +## Overview + + + + + +
Nameresolver_configs
TypeResource
Descriptionresolver_configs
Idawscc.route53resolver.resolver_configs
+ +## Fields + + + + + +
NameDatatypeDescription
resource_idstringResourceId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_configs resource, the following permissions are required: + +### Create +
+route53resolver:UpdateResolverConfig,
+route53resolver:GetResolverConfig,
+ec2:DescribeVpcs
+ +### List +
+route53resolver:ListResolverConfigs,
+ec2:DescribeVpcs
+ + +## Example +```sql +SELECT +region, +resource_id +FROM awscc.route53resolver.resolver_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config/index.md new file mode 100644 index 0000000000..60dcfb1ab6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config/index.md @@ -0,0 +1,81 @@ +--- +title: resolver_query_logging_config +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_config + - 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 +--- +Gets an individual resolver_query_logging_config resource + +## Overview + + + + + +
Nameresolver_query_logging_config
TypeResource
Descriptionresolver_query_logging_config
Idawscc.route53resolver.resolver_query_logging_config
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringResourceId
owner_idstringAccountId
statusstringResolverQueryLogConfigStatus, possible values are CREATING, CREATED, DELETED AND FAILED.
share_statusstringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
association_countintegerCount
arnstringArn
namestringResolverQueryLogConfigName
creator_request_idstringThe id of the creator request.
destination_arnstringdestination arn
creation_timestringRfc3339TimeString
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_query_logging_config resource, the following permissions are required: + +### Read +
+resolverquerylogging:GetConfig,
+route53resolver:GetResolverQueryLogConfig
+ +### Delete +
+resolverquerylogging:DeleteConfig,
+resolverquerylogging:ListConfig,
+route53resolver:DeleteResolverQueryLogConfig,
+route53resolver:ListResolverQueryLogConfigs
+ + +## Example +```sql +SELECT +region, +id, +owner_id, +status, +share_status, +association_count, +arn, +name, +creator_request_id, +destination_arn, +creation_time +FROM awscc.route53resolver.resolver_query_logging_config +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_association/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_association/index.md new file mode 100644 index 0000000000..9be06e0fe9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_association/index.md @@ -0,0 +1,76 @@ +--- +title: resolver_query_logging_config_association +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_config_association + - 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 +--- +Gets an individual resolver_query_logging_config_association resource + +## Overview + + + + + +
Nameresolver_query_logging_config_association
TypeResource
Descriptionresolver_query_logging_config_association
Idawscc.route53resolver.resolver_query_logging_config_association
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstringId
resolver_query_log_config_idstringResolverQueryLogConfigId
resource_idstringResourceId
statusstringResolverQueryLogConfigAssociationStatus
errorstringResolverQueryLogConfigAssociationError
error_messagestringResolverQueryLogConfigAssociationErrorMessage
creation_timestringRfc3339TimeString
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_query_logging_config_association resource, the following permissions are required: + +### Read +
+resolverquerylogging:GetConfigAssociation,
+route53resolver:GetResolverQueryLogConfigAssociation
+ +### Delete +
+resolverquerylogging:DisassociateConfig,
+resolverquerylogging:ListConfigAssociation,
+route53resolver:DisassociateResolverQueryLogConfig,
+route53resolver:ListResolverQueryLogConfigAssociations,
+route53resolver:GetResolverQueryLogConfigAssociation
+ + +## Example +```sql +SELECT +region, +id, +resolver_query_log_config_id, +resource_id, +status, +error, +error_message, +creation_time +FROM awscc.route53resolver.resolver_query_logging_config_association +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_associations/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_associations/index.md new file mode 100644 index 0000000000..10b15d3e5e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_associations/index.md @@ -0,0 +1,63 @@ +--- +title: resolver_query_logging_config_associations +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_config_associations + - 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 +--- +Retrieves a list of resolver_query_logging_config_associations in a region + +## Overview + + + + + +
Nameresolver_query_logging_config_associations
TypeResource
Descriptionresolver_query_logging_config_associations
Idawscc.route53resolver.resolver_query_logging_config_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_query_logging_config_associations resource, the following permissions are required: + +### Create +
+resolverquerylogging:AssociateConfig,
+resolverquerylogging:GetConfigAssociation,
+route53resolver:AssociateResolverQueryLogConfig,
+ec2:DescribeVpcs,
+route53resolver:GetResolverQueryLogConfigAssociation
+ +### List +
+resolverquerylogging:ListConfigAssociations,
+route53resolver:ListResolverQueryLogConfigAssociations
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53resolver.resolver_query_logging_config_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_configs/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_configs/index.md new file mode 100644 index 0000000000..9860df298b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_configs/index.md @@ -0,0 +1,71 @@ +--- +title: resolver_query_logging_configs +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_configs + - 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 +--- +Retrieves a list of resolver_query_logging_configs in a region + +## Overview + + + + + +
Nameresolver_query_logging_configs
TypeResource
Descriptionresolver_query_logging_configs
Idawscc.route53resolver.resolver_query_logging_configs
+ +## Fields + + + + + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_query_logging_configs resource, the following permissions are required: + +### Create +
+resolverquerylogging:CreateConfig,
+resolverquerylogging:GetConfig,
+route53resolver:CreateResolverQueryLogConfig,
+route53resolver:GetResolverQueryLogConfig,
+logs:CreateLogDelivery,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:DeleteLogDelivery,
+logs:ListLogDeliveries,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+iam:CreateServiceLinkedRole
+ +### List +
+resolverquerylogging:ListConfig,
+route53resolver:ListResolverQueryLogConfigs
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53resolver.resolver_query_logging_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md new file mode 100644 index 0000000000..a61557d84c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md @@ -0,0 +1,83 @@ +--- +title: resolver_rule +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rule + - 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 +--- +Gets an individual resolver_rule resource + +## Overview + + + + + +
Nameresolver_rule
TypeResource
Descriptionresolver_rule
Idawscc.route53resolver.resolver_rule
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
resolver_endpoint_idstringThe ID of the endpoint that the rule is associated with.
domain_namestringDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
namestringThe name for the Resolver rule
rule_typestringWhen 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.
tagsarrayAn array of key-value pairs to apply to this resource.
target_ipsarrayAn 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.
arnstringThe Amazon Resource Name (ARN) of the resolver rule.
resolver_rule_idstringThe ID of the endpoint that the rule is associated with.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_rule resource, the following permissions are required: + +### Read +
+route53resolver:GetResolverRule,
+route53resolver:ListTagsForResource
+ +### Update +
+route53resolver:UpdateResolverRule,
+route53resolver:GetResolverRule,
+route53resolver:ListTagsForResource,
+route53resolver:TagResource,
+route53resolver:UntagResource
+ +### Delete +
+route53resolver:DeleteResolverRule,
+route53resolver:GetResolverRule
+ + +## Example +```sql +SELECT +region, +resolver_endpoint_id, +domain_name, +name, +rule_type, +tags, +target_ips, +arn, +resolver_rule_id +FROM awscc.route53resolver.resolver_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<ResolverRuleId>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_association/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_association/index.md new file mode 100644 index 0000000000..f954cb92fd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_association/index.md @@ -0,0 +1,66 @@ +--- +title: resolver_rule_association +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rule_association + - 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 +--- +Gets an individual resolver_rule_association resource + +## Overview + + + + + +
Nameresolver_rule_association
TypeResource
Descriptionresolver_rule_association
Idawscc.route53resolver.resolver_rule_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
v_pc_idstringThe ID of the VPC that you associated the Resolver rule with.
resolver_rule_idstringThe ID of the Resolver rule that you associated with the VPC that is specified by ``VPCId``.
resolver_rule_association_idstring
namestringThe name of an association between a Resolver rule and a VPC.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_rule_association resource, the following permissions are required: + +### Read +
+route53resolver:GetResolverRuleAssociation
+ +### Delete +
+route53resolver:DisassociateResolverRule,
+route53resolver:GetResolverRuleAssociation
+ + +## Example +```sql +SELECT +region, +v_pc_id, +resolver_rule_id, +resolver_rule_association_id, +name +FROM awscc.route53resolver.resolver_rule_association +WHERE region = 'us-east-1' +AND data__Identifier = '<ResolverRuleAssociationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_associations/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_associations/index.md new file mode 100644 index 0000000000..5a2e779096 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_associations/index.md @@ -0,0 +1,60 @@ +--- +title: resolver_rule_associations +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rule_associations + - 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 +--- +Retrieves a list of resolver_rule_associations in a region + +## Overview + + + + + +
Nameresolver_rule_associations
TypeResource
Descriptionresolver_rule_associations
Idawscc.route53resolver.resolver_rule_associations
+ +## Fields + + + + + +
NameDatatypeDescription
resolver_rule_association_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_rule_associations resource, the following permissions are required: + +### Create +
+route53resolver:AssociateResolverRule,
+route53resolver:GetResolverRuleAssociation,
+ec2:DescribeVpcs
+ +### List +
+route53resolver:ListResolverRuleAssociations
+ + +## Example +```sql +SELECT +region, +resolver_rule_association_id +FROM awscc.route53resolver.resolver_rule_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md new file mode 100644 index 0000000000..dd8bae2603 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md @@ -0,0 +1,61 @@ +--- +title: resolver_rules +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rules + - 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 +--- +Retrieves a list of resolver_rules in a region + +## Overview + + + + + +
Nameresolver_rules
TypeResource
Descriptionresolver_rules
Idawscc.route53resolver.resolver_rules
+ +## Fields + + + + + +
NameDatatypeDescription
resolver_rule_idstringThe ID of the endpoint that the rule is associated with.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolver_rules resource, the following permissions are required: + +### Create +
+route53resolver:CreateResolverRule,
+route53resolver:GetResolverRule,
+route53resolver:ListTagsForResource,
+route53resolver:TagResource
+ +### List +
+route53resolver:ListResolverRules
+ + +## Example +```sql +SELECT +region, +resolver_rule_id +FROM awscc.route53resolver.resolver_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md new file mode 100644 index 0000000000..67546ae915 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md @@ -0,0 +1,69 @@ +--- +title: resolverdnssec_config +hide_title: false +hide_table_of_contents: false +keywords: + - resolverdnssec_config + - 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 +--- +Gets an individual resolverdnssec_config resource + +## Overview + + + + + +
Nameresolverdnssec_config
TypeResource
Descriptionresolverdnssec_config
Idawscc.route53resolver.resolverdnssec_config
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstringId
owner_idstringAccountId
resource_idstringResourceId
validation_statusstringResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolverdnssec_config resource, the following permissions are required: + +### Read +
+resolverdnssec:GetConfig,
+route53resolver:ListResolverDnssecConfigs
+ +### Delete +
+resolverdnssec:DeleteConfig,
+route53resolver:UpdateResolverDnssecConfig,
+route53resolver:ListResolverDnssecConfigs,
+ec2:DescribeVpcs
+ + +## Example +```sql +SELECT +region, +id, +owner_id, +resource_id, +validation_status +FROM awscc.route53resolver.resolverdnssec_config +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md new file mode 100644 index 0000000000..91425fd910 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md @@ -0,0 +1,62 @@ +--- +title: resolverdnssec_configs +hide_title: false +hide_table_of_contents: false +keywords: + - resolverdnssec_configs + - 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 +--- +Retrieves a list of resolverdnssec_configs in a region + +## Overview + + + + + +
Nameresolverdnssec_configs
TypeResource
Descriptionresolverdnssec_configs
Idawscc.route53resolver.resolverdnssec_configs
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resolverdnssec_configs resource, the following permissions are required: + +### Create +
+resolverdnssec:CreateConfig,
+route53resolver:UpdateResolverDnssecConfig,
+route53resolver:GetResolverDnssecConfig,
+ec2:DescribeVpcs
+ +### List +
+resolverdnssec:ListConfig,
+route53resolver:ListResolverDnssecConfigs
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.route53resolver.resolverdnssec_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rum/app_monitor/index.md b/docs/awscc-docs/providers/awscc/rum/app_monitor/index.md new file mode 100644 index 0000000000..d4891d2852 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rum/app_monitor/index.md @@ -0,0 +1,118 @@ +--- +title: app_monitor +hide_title: false +hide_table_of_contents: false +keywords: + - app_monitor + - 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 +--- +Gets an individual app_monitor resource + +## Overview + + + + + +
Nameapp_monitor
TypeResource
Descriptionapp_monitor
Idawscc.rum.app_monitor
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstringThe unique ID of the new app monitor.
namestringA name for the app monitor
domainstringThe top-level internet domain name for which your application has administrative authority.
cw_log_enabledbooleanData 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
tagsarray
app_monitor_configurationobject
custom_eventsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_monitor resource, the following permissions are required: + +### Read +
+rum:GetAppMonitor,
+dynamodb:GetItem,
+s3:GetObject,
+s3:DoesObjectExist,
+s3:GetObjectAcl,
+rum:ListTagsForResource,
+rum:ListRumMetricsDestinations,
+rum:BatchGetRumMetricDefinitions
+ +### Update +
+rum:UpdateAppMonitor,
+dynamodb:GetItem,
+dynamodb:PutItem,
+dynamodb:UpdateItem,
+dynamodb:Query,
+s3:GetObject,
+s3:PutObject,
+s3:GetObjectAcl,
+s3:DoesObjectExist,
+logs:CreateLogDelivery,
+logs:CreateLogGroup,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+logs:PutRetentionPolicy,
+rum:TagResource,
+rum:UntagResource,
+rum:ListTagsForResource,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+rum:PutRumMetricsDestination,
+rum:DeleteRumMetricsDestination,
+rum:ListRumMetricsDestinations,
+rum:BatchCreateRumMetricDefinitions,
+rum:BatchDeleteRumMetricDefinitions,
+rum:BatchGetRumMetricDefinitions,
+rum:UpdateRumMetricDefinition
+ +### Delete +
+rum:DeleteAppMonitor,
+dynamodb:DeleteItem,
+dynamodb:Query,
+logs:DeleteLogDelivery,
+s3:DeleteObject,
+s3:DoesObjectExist,
+rum:UntagResource,
+rum:DeleteRumMetricsDestination,
+rum:BatchDeleteRumMetricDefinitions
+ + +## Example +```sql +SELECT +region, +id, +name, +domain, +cw_log_enabled, +tags, +app_monitor_configuration, +custom_events +FROM awscc.rum.app_monitor +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/rum/app_monitors/index.md b/docs/awscc-docs/providers/awscc/rum/app_monitors/index.md new file mode 100644 index 0000000000..0970d3af49 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rum/app_monitors/index.md @@ -0,0 +1,88 @@ +--- +title: app_monitors +hide_title: false +hide_table_of_contents: false +keywords: + - app_monitors + - 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 +--- +Retrieves a list of app_monitors in a region + +## Overview + + + + + +
Nameapp_monitors
TypeResource
Descriptionapp_monitors
Idawscc.rum.app_monitors
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA name for the app monitor
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_monitors resource, the following permissions are required: + +### Create +
+rum:CreateAppMonitor,
+dynamodb:GetItem,
+dynamodb:PutItem,
+s3:GetObject,
+s3:PutObject,
+s3:GetObjectAcl,
+s3:DoesObjectExist,
+logs:CreateLogDelivery,
+logs:CreateLogGroup,
+logs:GetLogDelivery,
+logs:UpdateLogDelivery,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+logs:PutRetentionPolicy,
+rum:TagResource,
+cognito-identity:DescribeIdentityPool,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+rum:PutRumMetricsDestination,
+rum:BatchCreateRumMetricDefinitions
+ +### List +
+rum:ListAppMonitors,
+dynamodb:DescribeTable,
+rum:GetAppMonitor,
+dynamodb:GetItem,
+dynamodb:BatchGetItem,
+dynamodb:Query,
+s3:GetObject,
+s3:DoesObjectExist,
+s3:GetObjectAcl,
+logs:DescribeLogGroups,
+rum:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.rum.app_monitors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/rum/index.md b/docs/awscc-docs/providers/awscc/rum/index.md new file mode 100644 index 0000000000..918df15544 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/rum/index.md @@ -0,0 +1,39 @@ +--- +title: rum +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The rum service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+app_monitor +
+
+app_monitors +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/s3/access_grant/index.md b/docs/awscc-docs/providers/awscc/s3/access_grant/index.md new file mode 100644 index 0000000000..5934ddabad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_grant/index.md @@ -0,0 +1,81 @@ +--- +title: access_grant +hide_title: false +hide_table_of_contents: false +keywords: + - access_grant + - 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 +--- +Gets an individual access_grant resource + +## Overview + + + + + +
Nameaccess_grant
TypeResource
Descriptionaccess_grant
Idawscc.s3.access_grant
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
access_grant_idstringThe ID assigned to this access grant.
access_grants_location_idstringThe custom S3 location to be accessed by the grantee
tagsarray
permissionstringThe level of access to be afforded to the grantee
application_arnstringThe ARN of the application grantees will use to access the location
s3_prefix_typestringThe type of S3SubPrefix.
grant_scopestringThe 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.
access_grant_arnstringThe Amazon Resource Name (ARN) of the specified access grant.
granteeobjectThe principal who will be granted permission to access S3.
access_grants_location_configurationobjectThe configuration options of the grant location, which is the S3 path to the data to which you are granting access.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_grant resource, the following permissions are required: + +### Read +
+s3:GetAccessGrant
+ +### Delete +
+s3:DeleteAccessGrant
+ +### Update +
+s3:TagResource
+ + +## Example +```sql +SELECT +region, +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 awscc.s3.access_grant +WHERE region = 'us-east-1' +AND data__Identifier = '<AccessGrantId>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/access_grants/index.md b/docs/awscc-docs/providers/awscc/s3/access_grants/index.md new file mode 100644 index 0000000000..b2a59663db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_grants/index.md @@ -0,0 +1,59 @@ +--- +title: access_grants +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants + - 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 +--- +Retrieves a list of access_grants in a region + +## Overview + + + + + +
Nameaccess_grants
TypeResource
Descriptionaccess_grants
Idawscc.s3.access_grants
+ +## Fields + + + + + +
NameDatatypeDescription
access_grant_idstringThe ID assigned to this access grant.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_grants resource, the following permissions are required: + +### Create +
+s3:CreateAccessGrant,
+s3:TagResource
+ +### List +
+s3:ListAccessGrants
+ + +## Example +```sql +SELECT +region, +access_grant_id +FROM awscc.s3.access_grants +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/access_grants_instance/index.md b/docs/awscc-docs/providers/awscc/s3/access_grants_instance/index.md new file mode 100644 index 0000000000..847a7fa01b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_grants_instance/index.md @@ -0,0 +1,69 @@ +--- +title: access_grants_instance +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_instance + - 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 +--- +Gets an individual access_grants_instance resource + +## Overview + + + + + +
Nameaccess_grants_instance
TypeResource
Descriptionaccess_grants_instance
Idawscc.s3.access_grants_instance
+ +## Fields + + + + + + + + +
NameDatatypeDescription
access_grants_instance_arnstringThe Amazon Resource Name (ARN) of the specified Access Grants instance.
identity_center_arnstringThe Amazon Resource Name (ARN) of the specified AWS Identity Center.
access_grants_instance_idstringA unique identifier for the specified access grants instance.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_grants_instance resource, the following permissions are required: + +### Read +
+s3:GetAccessGrantsInstance
+ +### Delete +
+s3:DeleteAccessGrantsInstance
+ +### Update +
+s3:TagResource
+ + +## Example +```sql +SELECT +region, +access_grants_instance_arn, +identity_center_arn, +access_grants_instance_id, +tags +FROM awscc.s3.access_grants_instance +WHERE region = 'us-east-1' +AND data__Identifier = '<AccessGrantsInstanceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/access_grants_instances/index.md b/docs/awscc-docs/providers/awscc/s3/access_grants_instances/index.md new file mode 100644 index 0000000000..243cbd1e69 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_grants_instances/index.md @@ -0,0 +1,59 @@ +--- +title: access_grants_instances +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_instances + - 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 +--- +Retrieves a list of access_grants_instances in a region + +## Overview + + + + + +
Nameaccess_grants_instances
TypeResource
Descriptionaccess_grants_instances
Idawscc.s3.access_grants_instances
+ +## Fields + + + + + +
NameDatatypeDescription
access_grants_instance_arnundefinedThe Amazon Resource Name (ARN) of the specified Access Grants instance.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_grants_instances resource, the following permissions are required: + +### Create +
+s3:CreateAccessGrantsInstance,
+s3:TagResource
+ +### List +
+s3:ListAccessGrantsInstances
+ + +## Example +```sql +SELECT +region, +access_grants_instance_arn +FROM awscc.s3.access_grants_instances +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/access_grants_location/index.md b/docs/awscc-docs/providers/awscc/s3/access_grants_location/index.md new file mode 100644 index 0000000000..6d9130f0b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_grants_location/index.md @@ -0,0 +1,73 @@ +--- +title: access_grants_location +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_location + - 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 +--- +Gets an individual access_grants_location resource + +## Overview + + + + + +
Nameaccess_grants_location
TypeResource
Descriptionaccess_grants_location
Idawscc.s3.access_grants_location
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
access_grants_location_arnstringThe Amazon Resource Name (ARN) of the specified Access Grants location.
access_grants_location_idstringThe unique identifier for the specified Access Grants location.
iam_role_arnstringThe Amazon Resource Name (ARN) of the access grant location's associated IAM role.
location_scopestringDescriptor for where the location actually points
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_grants_location resource, the following permissions are required: + +### Read +
+s3:GetAccessGrantsLocation
+ +### Delete +
+s3:DeleteAccessGrantsLocation
+ +### Update +
+s3:UpdateAccessGrantsLocation,
+s3:TagResource,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +access_grants_location_arn, +access_grants_location_id, +iam_role_arn, +location_scope, +tags +FROM awscc.s3.access_grants_location +WHERE region = 'us-east-1' +AND data__Identifier = '<AccessGrantsLocationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/access_grants_locations/index.md b/docs/awscc-docs/providers/awscc/s3/access_grants_locations/index.md new file mode 100644 index 0000000000..a5fb34f9df --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_grants_locations/index.md @@ -0,0 +1,60 @@ +--- +title: access_grants_locations +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_locations + - 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 +--- +Retrieves a list of access_grants_locations in a region + +## Overview + + + + + +
Nameaccess_grants_locations
TypeResource
Descriptionaccess_grants_locations
Idawscc.s3.access_grants_locations
+ +## Fields + + + + + +
NameDatatypeDescription
access_grants_location_idstringThe unique identifier for the specified Access Grants location.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_grants_locations resource, the following permissions are required: + +### Create +
+s3:CreateAccessGrantsLocation,
+iam:PassRole,
+s3:TagResource
+ +### List +
+s3:ListAccessGrantsLocations
+ + +## Example +```sql +SELECT +region, +access_grants_location_id +FROM awscc.s3.access_grants_locations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/access_point/index.md b/docs/awscc-docs/providers/awscc/s3/access_point/index.md new file mode 100644 index 0000000000..fe4a8231a7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_point/index.md @@ -0,0 +1,85 @@ +--- +title: access_point +hide_title: false +hide_table_of_contents: false +keywords: + - access_point + - 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 +--- +Gets an individual access_point resource + +## Overview + + + + + +
Nameaccess_point
TypeResource
Descriptionaccess_point
Idawscc.s3.access_point
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe 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.
aliasstringThe alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.
bucketstringThe name of the bucket that you want to associate this Access Point with.
bucket_account_idstringThe AWS account ID associated with the S3 bucket associated with this access point.
vpc_configurationobjectIf you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC).
public_access_block_configurationobjectThe 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.
policyobjectThe Access Point Policy you want to apply to this access point.
network_originstringIndicates 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.
arnstringThe Amazon Resource Name (ARN) of the specified accesspoint.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +
+s3:GetAccessPoint,
+s3:GetAccessPointPolicy
+ +### Update +
+s3:PutAccessPointPolicy,
+s3:PutAccessPointPublicAccessBlock,
+s3:DeleteAccessPointPolicy,
+s3:GetAccessPoint,
+s3:GetAccessPointPolicy
+ +### Delete +
+s3:DeleteAccessPointPolicy,
+s3:DeleteAccessPoint
+ + +## Example +```sql +SELECT +region, +name, +alias, +bucket, +bucket_account_id, +vpc_configuration, +public_access_block_configuration, +policy, +network_origin, +arn +FROM awscc.s3.access_point +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/access_points/index.md b/docs/awscc-docs/providers/awscc/s3/access_points/index.md new file mode 100644 index 0000000000..9afb4d37b8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/access_points/index.md @@ -0,0 +1,60 @@ +--- +title: access_points +hide_title: false +hide_table_of_contents: false +keywords: + - access_points + - 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 +--- +Retrieves a list of access_points in a region + +## Overview + + + + + +
Nameaccess_points
TypeResource
Descriptionaccess_points
Idawscc.s3.access_points
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +
+s3:CreateAccessPoint,
+s3:PutAccessPointPolicy,
+s3:PutAccessPointPublicAccessBlock
+ +### List +
+s3:ListAccessPoints
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.s3.access_points +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/bucket/index.md b/docs/awscc-docs/providers/awscc/s3/bucket/index.md new file mode 100644 index 0000000000..137c0b14d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/bucket/index.md @@ -0,0 +1,158 @@ +--- +title: bucket +hide_title: false +hide_table_of_contents: false +keywords: + - bucket + - 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 +--- +Gets an individual bucket resource + +## Overview + + + + + +
Namebucket
TypeResource
Descriptionbucket
Idawscc.s3.bucket
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
accelerate_configurationobjectConfigures 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*.
access_controlstringThis 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*.<br/> 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*.<br/> 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.<br/> 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*.
analytics_configurationsarraySpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
bucket_encryptionobjectSpecifies 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*.
bucket_namestringA 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*. <br/> 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.
cors_configurationobjectDescribes 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*.
intelligent_tiering_configurationsarrayDefines how Amazon S3 handles Intelligent-Tiering storage.
inventory_configurationsarraySpecifies 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*.
lifecycle_configurationobjectSpecifies 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*.
logging_configurationobjectSettings that define where logs are stored.
metrics_configurationsarraySpecifies 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).
notification_configurationobjectConfiguration that defines how Amazon S3 handles bucket notifications.
object_lock_configurationobjectThis operation is not supported by directory buckets.<br/> 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). <br/> + The ``DefaultRetention`` settings require both a mode and a period.<br/> + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.<br/> + 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).
object_lock_enabledbooleanIndicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.
ownership_controlsobjectConfiguration that defines how Amazon S3 handles Object Ownership rules.
public_access_block_configurationobjectConfiguration that defines how Amazon S3 handles public access.
replication_configurationobjectConfiguration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property.<br/> Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
tagsarrayAn arbitrary set of tags (key-value pairs) for this S3 bucket.
versioning_configurationobjectEnables 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.
website_configurationobjectInformation 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).
arnstringThe Amazon Resource Name (ARN) of the specified bucket.
domain_namestringThe IPv4 DNS name of the specified bucket.
dual_stack_domain_namestringThe IPv6 DNS name of the specified bucket. For more information about dual-stack endpoints, see [Using Amazon S3 Dual-Stack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html).
regional_domain_namestringReturns the regional domain name of the specified bucket.
website_ur_lstringThe Amazon S3 website endpoint for the specified bucket.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket resource, the following permissions are required: + +### Read +
+s3:GetAccelerateConfiguration,
+s3:GetLifecycleConfiguration,
+s3:GetBucketPublicAccessBlock,
+s3:GetAnalyticsConfiguration,
+s3:GetBucketCORS,
+s3:GetEncryptionConfiguration,
+s3:GetInventoryConfiguration,
+s3:GetBucketLogging,
+s3:GetMetricsConfiguration,
+s3:GetBucketNotification,
+s3:GetBucketVersioning,
+s3:GetReplicationConfiguration,
+S3:GetBucketWebsite,
+s3:GetBucketPublicAccessBlock,
+s3:GetBucketObjectLockConfiguration,
+s3:GetBucketTagging,
+s3:GetBucketOwnershipControls,
+s3:GetIntelligentTieringConfiguration,
+s3:ListBucket
+ +### Update +
+s3:PutBucketAcl,
+s3:PutBucketTagging,
+s3:PutAnalyticsConfiguration,
+s3:PutEncryptionConfiguration,
+s3:PutBucketCORS,
+s3:PutInventoryConfiguration,
+s3:PutLifecycleConfiguration,
+s3:PutMetricsConfiguration,
+s3:PutBucketNotification,
+s3:PutBucketReplication,
+s3:PutBucketWebsite,
+s3:PutAccelerateConfiguration,
+s3:PutBucketPublicAccessBlock,
+s3:PutReplicationConfiguration,
+s3:PutBucketOwnershipControls,
+s3:PutIntelligentTieringConfiguration,
+s3:DeleteBucketWebsite,
+s3:PutBucketLogging,
+s3:PutBucketVersioning,
+s3:PutObjectLockConfiguration,
+s3:PutBucketObjectLockConfiguration,
+s3:DeleteBucketAnalyticsConfiguration,
+s3:DeleteBucketCors,
+s3:DeleteBucketMetricsConfiguration,
+s3:DeleteBucketEncryption,
+s3:DeleteBucketLifecycle,
+s3:DeleteBucketReplication,
+iam:PassRole,
+s3:ListBucket
+ +### Delete +
+s3:DeleteBucket,
+s3:ListBucket
+ + +## Example +```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, +tags, +versioning_configuration, +website_configuration, +arn, +domain_name, +dual_stack_domain_name, +regional_domain_name, +website_ur_l +FROM awscc.s3.bucket +WHERE region = 'us-east-1' +AND data__Identifier = '<BucketName>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md b/docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md new file mode 100644 index 0000000000..b9d9048a15 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md @@ -0,0 +1,60 @@ +--- +title: bucket_policies +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies + - 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 +--- +Retrieves a list of bucket_policies in a region + +## Overview + + + + + +
Namebucket_policies
TypeResource
Descriptionbucket_policies
Idawscc.s3.bucket_policies
+ +## Fields + + + + + +
NameDatatypeDescription
bucketstringThe name of the Amazon S3 bucket to which the policy applies.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +
+s3:GetBucketPolicy,
+s3:PutBucketPolicy
+ +### List +
+s3:GetBucketPolicy,
+s3:ListAllMyBuckets
+ + +## Example +```sql +SELECT +region, +bucket +FROM awscc.s3.bucket_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md b/docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md new file mode 100644 index 0000000000..722a90b8bf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md @@ -0,0 +1,67 @@ +--- +title: bucket_policy +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policy + - 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 +--- +Gets an individual bucket_policy resource + +## Overview + + + + + +
Namebucket_policy
TypeResource
Descriptionbucket_policy
Idawscc.s3.bucket_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
bucketstringThe name of the Amazon S3 bucket to which the policy applies.
policy_documentobjectA 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*.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket_policy resource, the following permissions are required: + +### Read +
+s3:GetBucketPolicy
+ +### Update +
+s3:GetBucketPolicy,
+s3:PutBucketPolicy
+ +### Delete +
+s3:GetBucketPolicy,
+s3:DeleteBucketPolicy
+ + +## Example +```sql +SELECT +region, +bucket, +policy_document +FROM awscc.s3.bucket_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Bucket>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/buckets/index.md b/docs/awscc-docs/providers/awscc/s3/buckets/index.md new file mode 100644 index 0000000000..9fcfa38e3b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/buckets/index.md @@ -0,0 +1,82 @@ +--- +title: buckets +hide_title: false +hide_table_of_contents: false +keywords: + - buckets + - 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 +--- +Retrieves a list of buckets in a region + +## Overview + + + + + +
Namebuckets
TypeResource
Descriptionbuckets
Idawscc.s3.buckets
+ +## Fields + + + + + +
NameDatatypeDescription
bucket_namestringA 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*. <br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the buckets resource, the following permissions are required: + +### Create +
+s3:CreateBucket,
+s3:PutBucketTagging,
+s3:PutAnalyticsConfiguration,
+s3:PutEncryptionConfiguration,
+s3:PutBucketCORS,
+s3:PutInventoryConfiguration,
+s3:PutLifecycleConfiguration,
+s3:PutMetricsConfiguration,
+s3:PutBucketNotification,
+s3:PutBucketReplication,
+s3:PutBucketWebsite,
+s3:PutAccelerateConfiguration,
+s3:PutBucketPublicAccessBlock,
+s3:PutReplicationConfiguration,
+s3:PutObjectAcl,
+s3:PutBucketObjectLockConfiguration,
+s3:GetBucketAcl,
+s3:ListBucket,
+iam:PassRole,
+s3:DeleteObject,
+s3:PutBucketLogging,
+s3:PutBucketVersioning,
+s3:PutObjectLockConfiguration,
+s3:PutBucketOwnershipControls,
+s3:PutIntelligentTieringConfiguration
+ +### List +
+s3:ListAllMyBuckets
+ + +## Example +```sql +SELECT +region, +bucket_name +FROM awscc.s3.buckets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/index.md b/docs/awscc-docs/providers/awscc/s3/index.md new file mode 100644 index 0000000000..24a6f43a4f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/index.md @@ -0,0 +1,56 @@ +--- +title: s3 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The s3 service documentation. + +:::info Service Summary + +
+
+total resources: 19
+total selectable resources: 19
+total methods: 19
+
+
+ +::: + +## Resources +
+
+access_grant
+access_grants
+access_grants_instance
+access_grants_instances
+access_grants_location
+access_grants_locations
+access_point
+access_points
+bucket
+bucket_policies +
+
+bucket_policy
+buckets
+multi_region_access_point
+multi_region_access_point_policies
+multi_region_access_point_policy
+multi_region_access_points
+storage_lens
+storage_lens_group
+storage_lens_groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/s3/multi_region_access_point/index.md b/docs/awscc-docs/providers/awscc/s3/multi_region_access_point/index.md new file mode 100644 index 0000000000..cbc07cc7e1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/multi_region_access_point/index.md @@ -0,0 +1,69 @@ +--- +title: multi_region_access_point +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_access_point + - 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 +--- +Gets an individual multi_region_access_point resource + +## Overview + + + + + +
Namemulti_region_access_point
TypeResource
Descriptionmulti_region_access_point
Idawscc.s3.multi_region_access_point
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Multi Region Access Point.
aliasstringThe alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point
created_atstringThe timestamp of the when the Multi Region Access Point is created
public_access_block_configurationobjectThe 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.
regionsarrayThe list of buckets that you want to associate this Multi Region Access Point with.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multi_region_access_point resource, the following permissions are required: + +### Read +
+s3:GetMultiRegionAccessPoint
+ +### Delete +
+s3:DeleteMultiRegionAccessPoint,
+s3:DescribeMultiRegionAccessPointOperation,
+s3:GetMultiRegionAccessPoint
+ + +## Example +```sql +SELECT +region, +name, +alias, +created_at, +public_access_block_configuration, +regions +FROM awscc.s3.multi_region_access_point +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policies/index.md b/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policies/index.md new file mode 100644 index 0000000000..4bcb76686b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policies/index.md @@ -0,0 +1,59 @@ +--- +title: multi_region_access_point_policies +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_access_point_policies + - 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 +--- +Retrieves a list of multi_region_access_point_policies in a region + +## Overview + + + + + +
Namemulti_region_access_point_policies
TypeResource
Descriptionmulti_region_access_point_policies
Idawscc.s3.multi_region_access_point_policies
+ +## Fields + + + + + +
NameDatatypeDescription
mrap_namestringThe name of the Multi Region Access Point to apply policy
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multi_region_access_point_policies resource, the following permissions are required: + +### List +
+
+ +### Create +
+s3:PutMultiRegionAccessPointPolicy,
+s3:DescribeMultiRegionAccessPointOperation
+ + +## Example +```sql +SELECT +region, +mrap_name +FROM awscc.s3.multi_region_access_point_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policy/index.md b/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policy/index.md new file mode 100644 index 0000000000..507dd20e28 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policy/index.md @@ -0,0 +1,70 @@ +--- +title: multi_region_access_point_policy +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_access_point_policy + - 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 +--- +Gets an individual multi_region_access_point_policy resource + +## Overview + + + + + +
Namemulti_region_access_point_policy
TypeResource
Descriptionmulti_region_access_point_policy
Idawscc.s3.multi_region_access_point_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
mrap_namestringThe name of the Multi Region Access Point to apply policy
policyobjectPolicy document to apply to a Multi Region Access Point
policy_statusobjectThe Policy Status associated with this Multi Region Access Point
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multi_region_access_point_policy resource, the following permissions are required: + +### Update +
+s3:PutMultiRegionAccessPointPolicy,
+s3:DescribeMultiRegionAccessPointOperation
+ +### Read +
+s3:GetMultiRegionAccessPointPolicy,
+s3:GetMultiRegionAccessPointPolicyStatus
+ +### Delete +
+s3:GetMultiRegionAccessPointPolicy,
+s3:GetMultiRegionAccessPoint
+ + +## Example +```sql +SELECT +region, +mrap_name, +policy, +policy_status +FROM awscc.s3.multi_region_access_point_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<MrapName>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/multi_region_access_points/index.md b/docs/awscc-docs/providers/awscc/s3/multi_region_access_points/index.md new file mode 100644 index 0000000000..79cd2c8611 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/multi_region_access_points/index.md @@ -0,0 +1,60 @@ +--- +title: multi_region_access_points +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_access_points + - 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 +--- +Retrieves a list of multi_region_access_points in a region + +## Overview + + + + + +
Namemulti_region_access_points
TypeResource
Descriptionmulti_region_access_points
Idawscc.s3.multi_region_access_points
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Multi Region Access Point.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the multi_region_access_points resource, the following permissions are required: + +### Create +
+s3:CreateMultiRegionAccessPoint,
+s3:DescribeMultiRegionAccessPointOperation,
+s3:GetMultiRegionAccessPoint
+ +### List +
+s3:ListMultiRegionAccessPoints
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.s3.multi_region_access_points +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/storage_lens/index.md b/docs/awscc-docs/providers/awscc/s3/storage_lens/index.md new file mode 100644 index 0000000000..543c9fc799 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/storage_lens/index.md @@ -0,0 +1,75 @@ +--- +title: storage_lens +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens + - 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 +--- +Gets an individual storage_lens resource + +## Overview + + + + + +
Namestorage_lens
TypeResource
Descriptionstorage_lens
Idawscc.s3.storage_lens
+ +## Fields + + + + + + +
NameDatatypeDescription
storage_lens_configurationobject
tagsarrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the storage_lens resource, the following permissions are required: + +### Read +
+s3:GetStorageLensConfiguration,
+s3:GetStorageLensConfigurationTagging
+ +### Update +
+s3:PutStorageLensConfiguration,
+s3:PutStorageLensConfigurationTagging,
+s3:GetStorageLensConfiguration,
+s3:GetStorageLensConfigurationTagging,
+organizations:DescribeOrganization,
+organizations:ListAccounts,
+organizations:ListAWSServiceAccessForOrganization,
+organizations:ListDelegatedAdministrators,
+iam:CreateServiceLinkedRole
+ +### Delete +
+s3:DeleteStorageLensConfiguration,
+s3:DeleteStorageLensConfigurationTagging
+ + +## Example +```sql +SELECT +region, +storage_lens_configuration, +tags +FROM awscc.s3.storage_lens +WHERE region = 'us-east-1' +AND data__Identifier = '<StorageLensConfiguration/Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/storage_lens_group/index.md b/docs/awscc-docs/providers/awscc/s3/storage_lens_group/index.md new file mode 100644 index 0000000000..cfa8d50aff --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/storage_lens_group/index.md @@ -0,0 +1,74 @@ +--- +title: storage_lens_group +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_group + - 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 +--- +Gets an individual storage_lens_group resource + +## Overview + + + + + +
Namestorage_lens_group
TypeResource
Descriptionstorage_lens_group
Idawscc.s3.storage_lens_group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestring
filterobject
storage_lens_group_arnstringThe ARN for the Amazon S3 Storage Lens Group.
tagsarrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens Group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the storage_lens_group resource, the following permissions are required: + +### Read +
+s3:GetStorageLensGroup,
+s3:ListTagsForResource
+ +### Update +
+s3:GetStorageLensGroup,
+s3:UpdateStorageLensGroup,
+s3:TagResource,
+s3:UntagResource,
+s3:ListTagsForResource
+ +### Delete +
+s3:DeleteStorageLensGroup
+ + +## Example +```sql +SELECT +region, +name, +filter, +storage_lens_group_arn, +tags +FROM awscc.s3.storage_lens_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3/storage_lens_groups/index.md b/docs/awscc-docs/providers/awscc/s3/storage_lens_groups/index.md new file mode 100644 index 0000000000..c8a3f2d445 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3/storage_lens_groups/index.md @@ -0,0 +1,61 @@ +--- +title: storage_lens_groups +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_groups + - 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 +--- +Retrieves a list of storage_lens_groups in a region + +## Overview + + + + + +
Namestorage_lens_groups
TypeResource
Descriptionstorage_lens_groups
Idawscc.s3.storage_lens_groups
+ +## Fields + + + + + +
NameDatatypeDescription
nameundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the storage_lens_groups resource, the following permissions are required: + +### Create +
+s3:CreateStorageLensGroup,
+s3:GetStorageLensGroup,
+s3:TagResource,
+s3:ListTagsForResource
+ +### List +
+s3:ListStorageLensGroups
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.s3.storage_lens_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md b/docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md new file mode 100644 index 0000000000..14263c85ee --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md @@ -0,0 +1,60 @@ +--- +title: bucket_policies +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies + - 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 +--- +Retrieves a list of bucket_policies in a region + +## Overview + + + + + +
Namebucket_policies
TypeResource
Descriptionbucket_policies
Idawscc.s3express.bucket_policies
+ +## Fields + + + + + +
NameDatatypeDescription
bucketstringThe name of the S3 directory bucket to which the policy applies.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +
+s3express:GetBucketPolicy,
+s3express:PutBucketPolicy
+ +### List +
+s3express:GetBucketPolicy,
+s3express:ListAllMyDirectoryBuckets
+ + +## Example +```sql +SELECT +region, +bucket +FROM awscc.s3express.bucket_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md b/docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md new file mode 100644 index 0000000000..56fc355bdd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md @@ -0,0 +1,67 @@ +--- +title: bucket_policy +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policy + - 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 +--- +Gets an individual bucket_policy resource + +## Overview + + + + + +
Namebucket_policy
TypeResource
Descriptionbucket_policy
Idawscc.s3express.bucket_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
bucketstringThe name of the S3 directory bucket to which the policy applies.
policy_documentobjectA 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket_policy resource, the following permissions are required: + +### Read +
+s3express:GetBucketPolicy
+ +### Update +
+s3express:GetBucketPolicy,
+s3express:PutBucketPolicy
+ +### Delete +
+s3express:GetBucketPolicy,
+s3express:DeleteBucketPolicy
+ + +## Example +```sql +SELECT +region, +bucket, +policy_document +FROM awscc.s3express.bucket_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Bucket>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md b/docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md new file mode 100644 index 0000000000..43437675a9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md @@ -0,0 +1,66 @@ +--- +title: directory_bucket +hide_title: false +hide_table_of_contents: false +keywords: + - directory_bucket + - 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 +--- +Gets an individual directory_bucket resource + +## Overview + + + + + +
Namedirectory_bucket
TypeResource
Descriptiondirectory_bucket
Idawscc.s3express.directory_bucket
+ +## Fields + + + + + + + + +
NameDatatypeDescription
bucket_namestringSpecifies 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.
location_namestringSpecifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
data_redundancystringSpecifies the number of Availability Zone that's used for redundancy for the bucket.
arnstringReturns the Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the directory_bucket resource, the following permissions are required: + +### Read +
+s3express:ListAllMyDirectoryBuckets
+ +### Delete +
+s3express:DeleteBucket,
+s3express:ListAllMyDirectoryBuckets
+ + +## Example +```sql +SELECT +region, +bucket_name, +location_name, +data_redundancy, +arn +FROM awscc.s3express.directory_bucket +WHERE region = 'us-east-1' +AND data__Identifier = '<BucketName>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md b/docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md new file mode 100644 index 0000000000..a81232c902 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md @@ -0,0 +1,59 @@ +--- +title: directory_buckets +hide_title: false +hide_table_of_contents: false +keywords: + - directory_buckets + - 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 +--- +Retrieves a list of directory_buckets in a region + +## Overview + + + + + +
Namedirectory_buckets
TypeResource
Descriptiondirectory_buckets
Idawscc.s3express.directory_buckets
+ +## Fields + + + + + +
NameDatatypeDescription
bucket_namestringSpecifies 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the directory_buckets resource, the following permissions are required: + +### Create +
+s3express:CreateBucket,
+s3express:ListAllMyDirectoryBuckets
+ +### List +
+s3express:ListAllMyDirectoryBuckets
+ + +## Example +```sql +SELECT +region, +bucket_name +FROM awscc.s3express.directory_buckets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3express/index.md b/docs/awscc-docs/providers/awscc/s3express/index.md new file mode 100644 index 0000000000..4899d4e113 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3express/index.md @@ -0,0 +1,41 @@ +--- +title: s3express +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The s3express service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+bucket_policies
+bucket_policy +
+
+directory_bucket
+directory_buckets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/s3objectlambda/access_point/index.md b/docs/awscc-docs/providers/awscc/s3objectlambda/access_point/index.md new file mode 100644 index 0000000000..f3544dbd83 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3objectlambda/access_point/index.md @@ -0,0 +1,80 @@ +--- +title: access_point +hide_title: false +hide_table_of_contents: false +keywords: + - access_point + - 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 +--- +Gets an individual access_point resource + +## Overview + + + + + +
Nameaccess_point
TypeResource
Descriptionaccess_point
Idawscc.s3objectlambda.access_point
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Object lambda Access Point.
aliasobject
arnstring
creation_datestringThe date and time when the Object lambda Access Point was created.
public_access_block_configurationobjectThe 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.
policy_statusobject
object_lambda_configurationobjectThe Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +
+s3:GetAccessPointForObjectLambda,
+s3:GetAccessPointPolicyStatusForObjectLambda,
+s3:GetAccessPointConfigurationForObjectLambda
+ +### Update +
+s3:PutAccessPointConfigurationForObjectLambda,
+s3:GetAccessPointForObjectLambda,
+s3:GetAccessPointPolicyStatusForObjectLambda,
+s3:GetAccessPointConfigurationForObjectLambda
+ +### Delete +
+s3:DeleteAccessPointForObjectLambda
+ + +## Example +```sql +SELECT +region, +name, +alias, +arn, +creation_date, +public_access_block_configuration, +policy_status, +object_lambda_configuration +FROM awscc.s3objectlambda.access_point +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policies/index.md b/docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policies/index.md new file mode 100644 index 0000000000..b1a4afc287 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policies/index.md @@ -0,0 +1,55 @@ +--- +title: access_point_policies +hide_title: false +hide_table_of_contents: false +keywords: + - access_point_policies + - 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 +--- +Retrieves a list of access_point_policies in a region + +## Overview + + + + + +
Nameaccess_point_policies
TypeResource
Descriptionaccess_point_policies
Idawscc.s3objectlambda.access_point_policies
+ +## Fields + + + + + +
NameDatatypeDescription
object_lambda_access_pointstringThe name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_point_policies resource, the following permissions are required: + +### Create +
+s3:PutAccessPointPolicyForObjectLambda,
+s3:GetAccessPointPolicyForObjectLambda
+ + +## Example +```sql +SELECT +region, +object_lambda_access_point +FROM awscc.s3objectlambda.access_point_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policy/index.md b/docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policy/index.md new file mode 100644 index 0000000000..004cdf836f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policy/index.md @@ -0,0 +1,67 @@ +--- +title: access_point_policy +hide_title: false +hide_table_of_contents: false +keywords: + - access_point_policy + - 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 +--- +Gets an individual access_point_policy resource + +## Overview + + + + + +
Nameaccess_point_policy
TypeResource
Descriptionaccess_point_policy
Idawscc.s3objectlambda.access_point_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
object_lambda_access_pointstringThe name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.
policy_documentobjectA policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_point_policy resource, the following permissions are required: + +### Read +
+s3:GetAccessPointPolicyForObjectLambda
+ +### Update +
+s3:PutAccessPointPolicyForObjectLambda,
+s3:GetAccessPointPolicyForObjectLambda
+ +### Delete +
+s3:DeleteAccessPointPolicyForObjectLambda,
+s3:GetAccessPointPolicyForObjectLambda
+ + +## Example +```sql +SELECT +region, +object_lambda_access_point, +policy_document +FROM awscc.s3objectlambda.access_point_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ObjectLambdaAccessPoint>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md b/docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md new file mode 100644 index 0000000000..cbaff538d1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md @@ -0,0 +1,62 @@ +--- +title: access_points +hide_title: false +hide_table_of_contents: false +keywords: + - access_points + - 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 +--- +Retrieves a list of access_points in a region + +## Overview + + + + + +
Nameaccess_points
TypeResource
Descriptionaccess_points
Idawscc.s3objectlambda.access_points
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Object lambda Access Point.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +
+s3:CreateAccessPointForObjectLambda,
+s3:PutAccessPointConfigurationForObjectLambda,
+s3:GetAccessPointForObjectLambda,
+s3:GetAccessPointPolicyStatusForObjectLambda,
+s3:GetAccessPointConfigurationForObjectLambda
+ +### List +
+s3:ListAccessPointsForObjectLambda
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.s3objectlambda.access_points +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3objectlambda/index.md b/docs/awscc-docs/providers/awscc/s3objectlambda/index.md new file mode 100644 index 0000000000..5b1affe4f3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3objectlambda/index.md @@ -0,0 +1,41 @@ +--- +title: s3objectlambda +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The s3objectlambda service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+access_point
+access_point_policies +
+
+access_point_policy
+access_points +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/s3outposts/access_point/index.md b/docs/awscc-docs/providers/awscc/s3outposts/access_point/index.md new file mode 100644 index 0000000000..465c09d617 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/access_point/index.md @@ -0,0 +1,76 @@ +--- +title: access_point +hide_title: false +hide_table_of_contents: false +keywords: + - access_point + - 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 +--- +Gets an individual access_point resource + +## Overview + + + + + +
Nameaccess_point
TypeResource
Descriptionaccess_point
Idawscc.s3outposts.access_point
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified AccessPoint.
bucketstringThe Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with.
namestringA name for the AccessPoint.
vpc_configurationobjectVirtual Private Cloud (VPC) from which requests can be made to the AccessPoint.
policyobjectThe access point policy associated with this access point.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +
+s3-outposts:GetAccessPoint,
+s3-outposts:GetAccessPointPolicy
+ +### Update +
+s3-outposts:GetAccessPoint,
+s3-outposts:PutAccessPointPolicy,
+s3-outposts:GetAccessPointPolicy,
+s3-outposts:DeleteAccessPointPolicy
+ +### Delete +
+s3-outposts:DeleteAccessPoint,
+s3-outposts:DeleteAccessPointPolicy
+ + +## Example +```sql +SELECT +region, +arn, +bucket, +name, +vpc_configuration, +policy +FROM awscc.s3outposts.access_point +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md b/docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md new file mode 100644 index 0000000000..a9876cb27e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md @@ -0,0 +1,61 @@ +--- +title: access_points +hide_title: false +hide_table_of_contents: false +keywords: + - access_points + - 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 +--- +Retrieves a list of access_points in a region + +## Overview + + + + + +
Nameaccess_points
TypeResource
Descriptionaccess_points
Idawscc.s3outposts.access_points
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified AccessPoint.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +
+s3-outposts:CreateAccessPoint,
+s3-outposts:GetAccessPoint,
+s3-outposts:PutAccessPointPolicy,
+s3-outposts:GetAccessPointPolicy
+ +### List +
+s3-outposts:ListAccessPoints
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.s3outposts.access_points +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md b/docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md new file mode 100644 index 0000000000..d294aa8421 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md @@ -0,0 +1,75 @@ +--- +title: bucket +hide_title: false +hide_table_of_contents: false +keywords: + - bucket + - 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 +--- +Gets an individual bucket resource + +## Overview + + + + + +
Namebucket
TypeResource
Descriptionbucket
Idawscc.s3outposts.bucket
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified bucket.
bucket_namestringA name for the bucket.
outpost_idstringThe id of the customer outpost on which the bucket resides.
tagsarrayAn arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
lifecycle_configurationobjectRules that define how Amazon S3Outposts manages objects during their lifetime.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket resource, the following permissions are required: + +### Read +
+s3-outposts:GetBucket,
+s3-outposts:GetBucketTagging,
+s3-outposts:GetLifecycleConfiguration
+ +### Update +
+s3-outposts:PutBucketTagging,
+s3-outposts:DeleteBucketTagging,
+s3-outposts:PutLifecycleConfiguration
+ +### Delete +
+s3-outposts:DeleteBucket
+ + +## Example +```sql +SELECT +region, +arn, +bucket_name, +outpost_id, +tags, +lifecycle_configuration +FROM awscc.s3outposts.bucket +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/bucket_policies/index.md b/docs/awscc-docs/providers/awscc/s3outposts/bucket_policies/index.md new file mode 100644 index 0000000000..411bc8c03e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/bucket_policies/index.md @@ -0,0 +1,55 @@ +--- +title: bucket_policies +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies + - 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 +--- +Retrieves a list of bucket_policies in a region + +## Overview + + + + + +
Namebucket_policies
TypeResource
Descriptionbucket_policies
Idawscc.s3outposts.bucket_policies
+ +## Fields + + + + + +
NameDatatypeDescription
bucketstringThe Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +
+s3-outposts:PutBucketPolicy,
+s3-outposts:GetBucketPolicy
+ + +## Example +```sql +SELECT +region, +bucket +FROM awscc.s3outposts.bucket_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md b/docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md new file mode 100644 index 0000000000..1da43a5dcd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md @@ -0,0 +1,67 @@ +--- +title: bucket_policy +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policy + - 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 +--- +Gets an individual bucket_policy resource + +## Overview + + + + + +
Namebucket_policy
TypeResource
Descriptionbucket_policy
Idawscc.s3outposts.bucket_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
bucketstringThe Amazon Resource Name (ARN) of the specified bucket.
policy_documentobjectA policy document containing permissions to add to the specified bucket.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the bucket_policy resource, the following permissions are required: + +### Read +
+s3-outposts:GetBucketPolicy
+ +### Update +
+s3-outposts:PutBucketPolicy,
+s3-outposts:GetBucketPolicy
+ +### Delete +
+s3-outposts:DeleteBucketPolicy,
+s3-outposts:GetBucketPolicy
+ + +## Example +```sql +SELECT +region, +bucket, +policy_document +FROM awscc.s3outposts.bucket_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Bucket>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md b/docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md new file mode 100644 index 0000000000..446a73ad36 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md @@ -0,0 +1,60 @@ +--- +title: buckets +hide_title: false +hide_table_of_contents: false +keywords: + - buckets + - 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 +--- +Retrieves a list of buckets in a region + +## Overview + + + + + +
Namebuckets
TypeResource
Descriptionbuckets
Idawscc.s3outposts.buckets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the buckets resource, the following permissions are required: + +### Create +
+s3-outposts:CreateBucket,
+s3-outposts:PutBucketTagging,
+s3-outposts:PutLifecycleConfiguration
+ +### List +
+s3-outposts:ListRegionalBuckets
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.s3outposts.buckets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md b/docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md new file mode 100644 index 0000000000..412b33fde4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md @@ -0,0 +1,81 @@ +--- +title: endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint + - 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 +--- +Gets an individual endpoint resource + +## Overview + + + + + +
Nameendpoint
TypeResource
Descriptionendpoint
Idawscc.s3outposts.endpoint
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the endpoint.
cidr_blockstringThe VPC CIDR committed by this endpoint.
creation_timestringThe time the endpoint was created.
idstringThe ID of the endpoint.
network_interfacesarrayThe network interfaces of the endpoint.
outpost_idstringThe id of the customer outpost on which the bucket resides.
security_group_idstringThe ID of the security group to use with the endpoint.
statusstring
subnet_idstringThe ID of the subnet in the selected VPC. The subnet must belong to the Outpost.
access_typestringThe 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.
customer_owned_ipv4_poolstringThe ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.
failed_reasonobjectThe failure reason, if any, for a create or delete endpoint operation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoint resource, the following permissions are required: + +### Read +
+s3-outposts:ListEndpoints
+ +### Delete +
+s3-outposts:DeleteEndpoint
+ + +## Example +```sql +SELECT +region, +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 awscc.s3outposts.endpoint +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md b/docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md new file mode 100644 index 0000000000..75bea12125 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md @@ -0,0 +1,58 @@ +--- +title: endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints + - 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 +--- +Retrieves a list of endpoints in a region + +## Overview + + + + + +
Nameendpoints
TypeResource
Descriptionendpoints
Idawscc.s3outposts.endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the endpoint.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the endpoints resource, the following permissions are required: + +### Create +
+s3-outposts:CreateEndpoint
+ +### List +
+s3-outposts:ListEndpoints
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.s3outposts.endpoints +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/s3outposts/index.md b/docs/awscc-docs/providers/awscc/s3outposts/index.md new file mode 100644 index 0000000000..05c27e2cf1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/s3outposts/index.md @@ -0,0 +1,45 @@ +--- +title: s3outposts +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The s3outposts service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+access_point
+access_points
+bucket
+bucket_policies +
+
+bucket_policy
+buckets
+endpoint
+endpoints +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/sagemaker/app/index.md b/docs/awscc-docs/providers/awscc/sagemaker/app/index.md new file mode 100644 index 0000000000..3da0c45102 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/app/index.md @@ -0,0 +1,76 @@ +--- +title: app +hide_title: false +hide_table_of_contents: false +keywords: + - app + - 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 +--- +Gets an individual app resource + +## Overview + + + + + +
Nameapp
TypeResource
Descriptionapp
Idawscc.sagemaker.app
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
app_arnstringThe Amazon Resource Name (ARN) of the app.
app_namestringThe name of the app.
app_typestringThe type of app.
domain_idstringThe domain ID.
resource_specobjectThe instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
tagsarrayA list of tags to apply to the app.
user_profile_namestringThe user profile name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app resource, the following permissions are required: + +### Read +
+sagemaker:DescribeApp,
+sagemaker:DescribeApp
+ +### Delete +
+sagemaker:DeleteApp,
+sagemaker:DescribeApp
+ + +## Example +```sql +SELECT +region, +app_arn, +app_name, +app_type, +domain_id, +resource_spec, +tags, +user_profile_name +FROM awscc.sagemaker.app +WHERE region = 'us-east-1' +AND data__Identifier = '<AppName>' +AND data__Identifier = '<AppType>' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<UserProfileName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/app_image_config/index.md b/docs/awscc-docs/providers/awscc/sagemaker/app_image_config/index.md new file mode 100644 index 0000000000..1d09999d0d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/app_image_config/index.md @@ -0,0 +1,73 @@ +--- +title: app_image_config +hide_title: false +hide_table_of_contents: false +keywords: + - app_image_config + - 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 +--- +Gets an individual app_image_config resource + +## Overview + + + + + +
Nameapp_image_config
TypeResource
Descriptionapp_image_config
Idawscc.sagemaker.app_image_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
app_image_config_arnstringThe Amazon Resource Name (ARN) of the AppImageConfig.
app_image_config_namestringThe Name of the AppImageConfig.
kernel_gateway_image_configobjectThe KernelGatewayImageConfig.
jupyter_lab_app_image_configobjectThe JupyterLabAppImageConfig.
tagsarrayA list of tags to apply to the AppImageConfig.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_image_config resource, the following permissions are required: + +### Read +
+sagemaker:DescribeAppImageConfig
+ +### Update +
+sagemaker:UpdateAppImageConfig,
+sagemaker:DescribeAppImageConfig
+ +### Delete +
+sagemaker:DeleteAppImageConfig,
+sagemaker:DescribeAppImageConfig
+ + +## Example +```sql +SELECT +region, +app_image_config_arn, +app_image_config_name, +kernel_gateway_image_config, +jupyter_lab_app_image_config, +tags +FROM awscc.sagemaker.app_image_config +WHERE region = 'us-east-1' +AND data__Identifier = '<AppImageConfigName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/app_image_configs/index.md b/docs/awscc-docs/providers/awscc/sagemaker/app_image_configs/index.md new file mode 100644 index 0000000000..ce63716f76 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/app_image_configs/index.md @@ -0,0 +1,59 @@ +--- +title: app_image_configs +hide_title: false +hide_table_of_contents: false +keywords: + - app_image_configs + - 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 +--- +Retrieves a list of app_image_configs in a region + +## Overview + + + + + +
Nameapp_image_configs
TypeResource
Descriptionapp_image_configs
Idawscc.sagemaker.app_image_configs
+ +## Fields + + + + + +
NameDatatypeDescription
app_image_config_namestringThe Name of the AppImageConfig.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the app_image_configs resource, the following permissions are required: + +### Create +
+sagemaker:CreateAppImageConfig,
+sagemaker:DescribeAppImageConfig
+ +### List +
+sagemaker:ListAppImageConfigs
+ + +## Example +```sql +SELECT +region, +app_image_config_name +FROM awscc.sagemaker.app_image_configs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/apps/index.md b/docs/awscc-docs/providers/awscc/sagemaker/apps/index.md new file mode 100644 index 0000000000..dcba571fe1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/apps/index.md @@ -0,0 +1,65 @@ +--- +title: apps +hide_title: false +hide_table_of_contents: false +keywords: + - apps + - 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 +--- +Retrieves a list of apps in a region + +## Overview + + + + + +
Nameapps
TypeResource
Descriptionapps
Idawscc.sagemaker.apps
+ +## Fields + + + + + + + + +
NameDatatypeDescription
app_namestringThe name of the app.
app_typestringThe type of app.
domain_idstringThe domain ID.
user_profile_namestringThe user profile name.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the apps resource, the following permissions are required: + +### Create +
+sagemaker:CreateApp,
+sagemaker:DescribeApp
+ +### List +
+sagemaker:ListApps
+ + +## Example +```sql +SELECT +region, +app_name, +app_type, +domain_id, +user_profile_name +FROM awscc.sagemaker.apps +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definition/index.md b/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definition/index.md new file mode 100644 index 0000000000..ef8228fb3d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definition/index.md @@ -0,0 +1,83 @@ +--- +title: data_quality_job_definition +hide_title: false +hide_table_of_contents: false +keywords: + - data_quality_job_definition + - 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 +--- +Gets an individual data_quality_job_definition resource + +## Overview + + + + + +
Namedata_quality_job_definition
TypeResource
Descriptiondata_quality_job_definition
Idawscc.sagemaker.data_quality_job_definition
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
data_quality_baseline_configobject
data_quality_app_specificationobject
data_quality_job_inputobject
data_quality_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_quality_job_definition resource, the following permissions are required: + +### Delete +
+sagemaker:DeleteDataQualityJobDefinition
+ +### Read +
+sagemaker:DescribeDataQualityJobDefinition
+ + +## Example +```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, +tags, +creation_time +FROM awscc.sagemaker.data_quality_job_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<JobDefinitionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definitions/index.md b/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definitions/index.md new file mode 100644 index 0000000000..68e5fb3cc4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definitions/index.md @@ -0,0 +1,62 @@ +--- +title: data_quality_job_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - data_quality_job_definitions + - 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 +--- +Retrieves a list of data_quality_job_definitions in a region + +## Overview + + + + + +
Namedata_quality_job_definitions
TypeResource
Descriptiondata_quality_job_definitions
Idawscc.sagemaker.data_quality_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the data_quality_job_definitions resource, the following permissions are required: + +### Create +
+sagemaker:CreateDataQualityJobDefinition,
+sagemaker:DescribeDataQualityJobDefinition,
+sagemaker:AddTags,
+iam:PassRole
+ +### List +
+sagemaker:ListDataQualityJobDefinitions,
+sagemaker:ListTags
+ + +## Example +```sql +SELECT +region, +job_definition_arn +FROM awscc.sagemaker.data_quality_job_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/device/index.md b/docs/awscc-docs/providers/awscc/sagemaker/device/index.md new file mode 100644 index 0000000000..c257f5320f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/device/index.md @@ -0,0 +1,67 @@ +--- +title: device +hide_title: false +hide_table_of_contents: false +keywords: + - device + - 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 +--- +Gets an individual device resource + +## Overview + + + + + +
Namedevice
TypeResource
Descriptiondevice
Idawscc.sagemaker.device
+ +## Fields + + + + + + + +
NameDatatypeDescription
device_fleet_namestringThe name of the edge device fleet
deviceobjectThe Edge Device you want to register against a device fleet
tagsarrayAssociate tags with the resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the device resource, the following permissions are required: + +### Read +
+sagemaker:DescribeDevice
+ +### Update +
+sagemaker:UpdateDevices
+ +### Delete +
+sagemaker:DeregisterDevices
+ + +## Example +```sql +SELECT +region, +device_fleet_name, +device, +tags +FROM awscc.sagemaker.device +WHERE region = 'us-east-1' +AND data__Identifier = '<Device/DeviceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md b/docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md new file mode 100644 index 0000000000..718073fef9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md @@ -0,0 +1,72 @@ +--- +title: device_fleet +hide_title: false +hide_table_of_contents: false +keywords: + - device_fleet + - 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 +--- +Gets an individual device_fleet resource + +## Overview + + + + + +
Namedevice_fleet
TypeResource
Descriptiondevice_fleet
Idawscc.sagemaker.device_fleet
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstringDescription for the edge device fleet
device_fleet_namestringThe name of the edge device fleet
output_configobjectS3 bucket and an ecryption key id (if available) to store outputs for the fleet
role_arnstringRole associated with the device fleet
tagsarrayAssociate tags with the resource
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the device_fleet resource, the following permissions are required: + +### Read +
+sagemaker:DescribeDeviceFleet
+ +### Update +
+sagemaker:UpdateDeviceFleet,
+iam:PassRole
+ +### Delete +
+sagemaker:DeleteDeviceFleet
+ + +## Example +```sql +SELECT +region, +description, +device_fleet_name, +output_config, +role_arn, +tags +FROM awscc.sagemaker.device_fleet +WHERE region = 'us-east-1' +AND data__Identifier = '<DeviceFleetName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/device_fleets/index.md b/docs/awscc-docs/providers/awscc/sagemaker/device_fleets/index.md new file mode 100644 index 0000000000..4fb9158c03 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/device_fleets/index.md @@ -0,0 +1,55 @@ +--- +title: device_fleets +hide_title: false +hide_table_of_contents: false +keywords: + - device_fleets + - 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 +--- +Retrieves a list of device_fleets in a region + +## Overview + + + + + +
Namedevice_fleets
TypeResource
Descriptiondevice_fleets
Idawscc.sagemaker.device_fleets
+ +## Fields + + + + + +
NameDatatypeDescription
device_fleet_namestringThe name of the edge device fleet
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the device_fleets resource, the following permissions are required: + +### Create +
+sagemaker:CreateDeviceFleet,
+iam:PassRole
+ + +## Example +```sql +SELECT +region, +device_fleet_name +FROM awscc.sagemaker.device_fleets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/devices/index.md b/docs/awscc-docs/providers/awscc/sagemaker/devices/index.md new file mode 100644 index 0000000000..88b7e56a96 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/devices/index.md @@ -0,0 +1,54 @@ +--- +title: devices +hide_title: false +hide_table_of_contents: false +keywords: + - devices + - 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 +--- +Retrieves a list of devices in a region + +## Overview + + + + + +
Namedevices
TypeResource
Descriptiondevices
Idawscc.sagemaker.devices
+ +## Fields + + + + + +
NameDatatypeDescription
device/device_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the devices resource, the following permissions are required: + +### Create +
+sagemaker:RegisterDevices
+ + +## Example +```sql +SELECT +region, +device/device_name +FROM awscc.sagemaker.devices +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md b/docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md new file mode 100644 index 0000000000..4270008822 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md @@ -0,0 +1,91 @@ +--- +title: feature_group +hide_title: false +hide_table_of_contents: false +keywords: + - feature_group + - 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 +--- +Gets an individual feature_group resource + +## Overview + + + + + +
Namefeature_group
TypeResource
Descriptionfeature_group
Idawscc.sagemaker.feature_group
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
feature_group_namestringThe Name of the FeatureGroup.
record_identifier_feature_namestringThe Record Identifier Feature Name.
event_time_feature_namestringThe Event Time Feature Name.
feature_definitionsarrayAn Array of Feature Definition
online_store_configobject
offline_store_configobject
throughput_configobject
role_arnstringRole Arn
descriptionstringDescription about the FeatureGroup.
creation_timestringA timestamp of FeatureGroup creation time.
feature_group_statusstringThe status of the feature group.
tagsarrayAn array of key-value pair to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the feature_group resource, the following permissions are required: + +### Update +
+sagemaker:UpdateFeatureGroup,
+sagemaker:DescribeFeatureGroup,
+sagemaker:AddTags,
+sagemaker:ListTags,
+sagemaker:DeleteTags
+ +### Read +
+sagemaker:DescribeFeatureGroup,
+sagemaker:ListTags
+ +### Delete +
+sagemaker:DeleteFeatureGroup,
+sagemaker:DescribeFeatureGroup
+ + +## Example +```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, +tags +FROM awscc.sagemaker.feature_group +WHERE region = 'us-east-1' +AND data__Identifier = '<FeatureGroupName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md b/docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md new file mode 100644 index 0000000000..8a98a74da9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md @@ -0,0 +1,68 @@ +--- +title: feature_groups +hide_title: false +hide_table_of_contents: false +keywords: + - feature_groups + - 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 +--- +Retrieves a list of feature_groups in a region + +## Overview + + + + + +
Namefeature_groups
TypeResource
Descriptionfeature_groups
Idawscc.sagemaker.feature_groups
+ +## Fields + + + + + +
NameDatatypeDescription
feature_group_namestringThe Name of the FeatureGroup.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the feature_groups resource, the following permissions are required: + +### Create +
+iam:PassRole,
+kms:CreateGrant,
+kms:DescribeKey,
+glue:CreateTable,
+glue:GetTable,
+glue:CreateDatabase,
+glue:GetDatabase,
+sagemaker:CreateFeatureGroup,
+sagemaker:DescribeFeatureGroup,
+sagemaker:AddTags,
+sagemaker:ListTags
+ +### List +
+sagemaker:ListFeatureGroups
+ + +## Example +```sql +SELECT +region, +feature_group_name +FROM awscc.sagemaker.feature_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/image/index.md b/docs/awscc-docs/providers/awscc/sagemaker/image/index.md new file mode 100644 index 0000000000..b682ab3ed6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/image/index.md @@ -0,0 +1,80 @@ +--- +title: image +hide_title: false +hide_table_of_contents: false +keywords: + - image + - 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 +--- +Gets an individual image resource + +## Overview + + + + + +
Nameimage
TypeResource
Descriptionimage
Idawscc.sagemaker.image
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
image_namestring
image_arnstring
image_role_arnstring
image_display_namestring
image_descriptionstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image resource, the following permissions are required: + +### Read +
+sagemaker:DescribeImage,
+sagemaker:ListTags
+ +### Update +
+sagemaker:UpdateImage,
+sagemaker:DescribeImage,
+sagemaker:ListTags,
+sagemaker:AddTags,
+sagemaker:DeleteTags,
+iam:PassRole
+ +### Delete +
+sagemaker:DeleteImage,
+sagemaker:DescribeImage
+ + +## Example +```sql +SELECT +region, +image_name, +image_arn, +image_role_arn, +image_display_name, +image_description, +tags +FROM awscc.sagemaker.image +WHERE region = 'us-east-1' +AND data__Identifier = '<ImageArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md b/docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md new file mode 100644 index 0000000000..c05c72ce13 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md @@ -0,0 +1,94 @@ +--- +title: image_version +hide_title: false +hide_table_of_contents: false +keywords: + - image_version + - 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 +--- +Gets an individual image_version resource + +## Overview + + + + + +
Nameimage_version
TypeResource
Descriptionimage_version
Idawscc.sagemaker.image_version
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
image_namestring
image_arnstring
image_version_arnstring
base_imagestring
container_imagestring
versioninteger
aliasstring
aliasesarray
vendor_guidancestring
job_typestring
m_lframeworkstring
programming_langstring
processorstring
horovodboolean
release_notesstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_version resource, the following permissions are required: + +### Read +
+sagemaker:DescribeImageVersion
+ +### Update +
+sagemaker:UpdateImageVersion,
+sagemaker:DescribeImageVersion,
+sagemaker:ListAliases
+ +### Delete +
+sagemaker:DeleteImageVersion,
+sagemaker:DescribeImageVersion
+ + +## Example +```sql +SELECT +region, +image_name, +image_arn, +image_version_arn, +base_image, +container_image, +version, +alias, +aliases, +vendor_guidance, +job_type, +m_lframework, +programming_lang, +processor, +horovod, +release_notes +FROM awscc.sagemaker.image_version +WHERE region = 'us-east-1' +AND data__Identifier = '<ImageVersionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md b/docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md new file mode 100644 index 0000000000..8b727976bb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md @@ -0,0 +1,59 @@ +--- +title: image_versions +hide_title: false +hide_table_of_contents: false +keywords: + - image_versions + - 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 +--- +Retrieves a list of image_versions in a region + +## Overview + + + + + +
Nameimage_versions
TypeResource
Descriptionimage_versions
Idawscc.sagemaker.image_versions
+ +## Fields + + + + + +
NameDatatypeDescription
image_version_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the image_versions resource, the following permissions are required: + +### Create +
+sagemaker:CreateImageVersion,
+sagemaker:DescribeImageVersion
+ +### List +
+sagemaker:ListImageVersions
+ + +## Example +```sql +SELECT +region, +image_version_arn +FROM awscc.sagemaker.image_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/images/index.md b/docs/awscc-docs/providers/awscc/sagemaker/images/index.md new file mode 100644 index 0000000000..16da47e4ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/images/index.md @@ -0,0 +1,62 @@ +--- +title: images +hide_title: false +hide_table_of_contents: false +keywords: + - images + - 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 +--- +Retrieves a list of images in a region + +## Overview + + + + + +
Nameimages
TypeResource
Descriptionimages
Idawscc.sagemaker.images
+ +## Fields + + + + + +
NameDatatypeDescription
image_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the images resource, the following permissions are required: + +### Create +
+sagemaker:CreateImage,
+sagemaker:DescribeImage,
+iam:PassRole,
+sagemaker:AddTags,
+sagemaker:ListTags
+ +### List +
+sagemaker:ListImages
+ + +## Example +```sql +SELECT +region, +image_arn +FROM awscc.sagemaker.images +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/index.md b/docs/awscc-docs/providers/awscc/sagemaker/index.md new file mode 100644 index 0000000000..967efc1d05 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/index.md @@ -0,0 +1,79 @@ +--- +title: sagemaker +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The sagemaker service documentation. + +:::info Service Summary + +
+
+total resources: 42
+total selectable resources: 42
+total methods: 42
+
+
+ +::: + +## Resources +
+
+app
+app_image_config
+app_image_configs
+apps
+data_quality_job_definition
+data_quality_job_definitions
+device
+device_fleet
+device_fleets
+devices
+feature_group
+feature_groups
+image
+image_version
+image_versions
+images
+inference_component
+inference_components
+inference_experiment
+inference_experiments
+model_bias_job_definition +
+
+model_bias_job_definitions
+model_card
+model_cards
+model_explainability_job_definition
+model_explainability_job_definitions
+model_package
+model_package_group
+model_package_groups
+model_packages
+model_quality_job_definition
+model_quality_job_definitions
+monitoring_schedule
+monitoring_schedules
+pipeline
+pipelines
+project
+projects
+space
+spaces
+user_profile
+user_profiles +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/sagemaker/inference_component/index.md b/docs/awscc-docs/providers/awscc/sagemaker/inference_component/index.md new file mode 100644 index 0000000000..97468a7eb4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/inference_component/index.md @@ -0,0 +1,93 @@ +--- +title: inference_component +hide_title: false +hide_table_of_contents: false +keywords: + - inference_component + - 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 +--- +Gets an individual inference_component resource + +## Overview + + + + + +
Nameinference_component
TypeResource
Descriptioninference_component
Idawscc.sagemaker.inference_component
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
inference_component_arnstring
inference_component_namestring
endpoint_arnstring
endpoint_namestring
variant_namestring
failure_reasonstring
specificationobject
runtime_configobject
inference_component_statusstring
creation_timestring
last_modified_timestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the inference_component resource, the following permissions are required: + +### Update +
+sagemaker:UpdateInferenceComponent,
+sagemaker:UpdateInferenceComponentRuntimeConfig,
+sagemaker:DescribeInferenceComponent,
+sagemaker:AddTags,
+sagemaker:ListTags,
+sagemaker:DeleteTags
+ +### Delete +
+sagemaker:DescribeInferenceComponent,
+sagemaker:DeleteInferenceComponent,
+sagemaker:DeleteTags
+ +### Read +
+sagemaker:DescribeInferenceComponent,
+sagemaker:ListTags
+ + +## Example +```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, +tags +FROM awscc.sagemaker.inference_component +WHERE region = 'us-east-1' +AND data__Identifier = '<InferenceComponentArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md b/docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md new file mode 100644 index 0000000000..6a967d91f6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md @@ -0,0 +1,63 @@ +--- +title: inference_components +hide_title: false +hide_table_of_contents: false +keywords: + - inference_components + - 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 +--- +Retrieves a list of inference_components in a region + +## Overview + + + + + +
Nameinference_components
TypeResource
Descriptioninference_components
Idawscc.sagemaker.inference_components
+ +## Fields + + + + + +
NameDatatypeDescription
inference_component_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the inference_components resource, the following permissions are required: + +### Create +
+sagemaker:AddTags,
+sagemaker:ListTags,
+sagemaker:CreateInferenceComponent,
+sagemaker:DescribeInferenceComponent
+ +### List +
+sagemaker:ListInferenceComponents,
+sagemaker:DescribeInferenceComponent,
+sagemaker:ListTags
+ + +## Example +```sql +SELECT +region, +inference_component_arn +FROM awscc.sagemaker.inference_components +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md b/docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md new file mode 100644 index 0000000000..91cf5b5d42 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md @@ -0,0 +1,107 @@ +--- +title: inference_experiment +hide_title: false +hide_table_of_contents: false +keywords: + - inference_experiment + - 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 +--- +Gets an individual inference_experiment resource + +## Overview + + + + + +
Nameinference_experiment
TypeResource
Descriptioninference_experiment
Idawscc.sagemaker.inference_experiment
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the inference experiment.
namestringThe name for the inference experiment.
typestringThe type of the inference experiment that you want to run.
descriptionstringThe description of the inference experiment.
role_arnstringThe 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.
endpoint_namestring
endpoint_metadataobject
scheduleobject
kms_keystringThe 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.
data_storage_configobject
model_variantsarrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
shadow_mode_configobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe timestamp at which you created the inference experiment.
last_modified_timestringThe timestamp at which you last modified the inference experiment.
statusstringThe status of the inference experiment.
status_reasonstringThe error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
desired_statestringThe desired state of the experiment after starting or stopping operation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the inference_experiment resource, the following permissions are required: + +### Delete +
+sagemaker:DeleteInferenceExperiment,
+sagemaker:DescribeInferenceExperiment,
+sagemaker:StopInferenceExperiment,
+sagemaker:ListTags
+ +### Read +
+sagemaker:DescribeInferenceExperiment,
+sagemaker:ListTags
+ +### Update +
+sagemaker:UpdateInferenceExperiment,
+sagemaker:StartInferenceExperiment,
+sagemaker:StopInferenceExperiment,
+sagemaker:DescribeInferenceExperiment,
+sagemaker:AddTags,
+sagemaker:DeleteTags,
+sagemaker:ListTags
+ + +## Example +```sql +SELECT +region, +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 awscc.sagemaker.inference_experiment +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md b/docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md new file mode 100644 index 0000000000..ed91ab665c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md @@ -0,0 +1,62 @@ +--- +title: inference_experiments +hide_title: false +hide_table_of_contents: false +keywords: + - inference_experiments + - 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 +--- +Retrieves a list of inference_experiments in a region + +## Overview + + + + + +
Nameinference_experiments
TypeResource
Descriptioninference_experiments
Idawscc.sagemaker.inference_experiments
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name for the inference experiment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the inference_experiments resource, the following permissions are required: + +### Create +
+sagemaker:CreateInferenceExperiment,
+sagemaker:DescribeInferenceExperiment,
+sagemaker:AddTags,
+sagemaker:ListTags,
+iam:PassRole
+ +### List +
+sagemaker:ListInferenceExperiments
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.sagemaker.inference_experiments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definition/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definition/index.md new file mode 100644 index 0000000000..778f7c0b09 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definition/index.md @@ -0,0 +1,83 @@ +--- +title: model_bias_job_definition +hide_title: false +hide_table_of_contents: false +keywords: + - model_bias_job_definition + - 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 +--- +Gets an individual model_bias_job_definition resource + +## Overview + + + + + +
Namemodel_bias_job_definition
TypeResource
Descriptionmodel_bias_job_definition
Idawscc.sagemaker.model_bias_job_definition
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
model_bias_baseline_configobject
model_bias_app_specificationobject
model_bias_job_inputobject
model_bias_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_bias_job_definition resource, the following permissions are required: + +### Delete +
+sagemaker:DeleteModelBiasJobDefinition
+ +### Read +
+sagemaker:DescribeModelBiasJobDefinition
+ + +## Example +```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, +tags, +creation_time +FROM awscc.sagemaker.model_bias_job_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<JobDefinitionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definitions/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definitions/index.md new file mode 100644 index 0000000000..648515f3ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definitions/index.md @@ -0,0 +1,62 @@ +--- +title: model_bias_job_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - model_bias_job_definitions + - 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 +--- +Retrieves a list of model_bias_job_definitions in a region + +## Overview + + + + + +
Namemodel_bias_job_definitions
TypeResource
Descriptionmodel_bias_job_definitions
Idawscc.sagemaker.model_bias_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_bias_job_definitions resource, the following permissions are required: + +### Create +
+sagemaker:CreateModelBiasJobDefinition,
+sagemaker:DescribeModelBiasJobDefinition,
+iam:PassRole,
+sagemaker:AddTags
+ +### List +
+sagemaker:ListModelBiasJobDefinitions,
+sagemaker:ListTags
+ + +## Example +```sql +SELECT +region, +job_definition_arn +FROM awscc.sagemaker.model_bias_job_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md new file mode 100644 index 0000000000..6c50b16ec8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md @@ -0,0 +1,104 @@ +--- +title: model_card +hide_title: false +hide_table_of_contents: false +keywords: + - model_card + - 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 +--- +Gets an individual model_card resource + +## Overview + + + + + +
Namemodel_card
TypeResource
Descriptionmodel_card
Idawscc.sagemaker.model_card
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
model_card_arnstringThe Amazon Resource Name (ARN) of the successfully created model card.
model_card_versionintegerA version of the model card.
model_card_namestringThe unique name of the model card.
security_configobject
model_card_statusstringThe approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
contentobject
creation_timestringThe date and time the model card was created.
created_byobjectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
last_modified_timestringThe date and time the model card was last modified.
last_modified_byobjectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
model_card_processing_statusstringThe processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
tagsarrayKey-value pairs used to manage metadata for model cards.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_card resource, the following permissions are required: + +### Read +
+sagemaker:DescribeModelCard,
+sagemaker:DescribeModelPackageGroup,
+sagemaker:DescribeModelPackage,
+kms:Decrypt,
+sagemaker:ListTags
+ +### Update +
+sagemaker:UpdateModelCard,
+sagemaker:DescribeModelCard,
+kms:GenerateDataKey,
+kms:Decrypt,
+sagemaker:DescribeModelPackageGroup,
+sagemaker:DescribeModelPackage,
+sagemaker:ListTags,
+sagemaker:AddTags,
+sagemaker:DeleteTags
+ +### Delete +
+sagemaker:DescribeModelCard,
+sagemaker:DeleteModelCard,
+sagemaker:DescribeModelPackageGroup,
+sagemaker:DescribeModelPackage,
+kms:RetireGrant,
+kms:Decrypt,
+sagemaker:ListTags,
+sagemaker:DeleteTags
+ + +## Example +```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, +tags +FROM awscc.sagemaker.model_card +WHERE region = 'us-east-1' +AND data__Identifier = '<ModelCardName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md new file mode 100644 index 0000000000..a499e29b7a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md @@ -0,0 +1,65 @@ +--- +title: model_cards +hide_title: false +hide_table_of_contents: false +keywords: + - model_cards + - 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 +--- +Retrieves a list of model_cards in a region + +## Overview + + + + + +
Namemodel_cards
TypeResource
Descriptionmodel_cards
Idawscc.sagemaker.model_cards
+ +## Fields + + + + + +
NameDatatypeDescription
model_card_namestringThe unique name of the model card.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_cards resource, the following permissions are required: + +### Create +
+sagemaker:CreateModelCard,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:CreateGrant,
+sagemaker:DescribeModelPackageGroup,
+sagemaker:DescribeModelPackage,
+sagemaker:AddTags
+ +### List +
+sagemaker:ListModelCards,
+sagemaker:ListModelCardVersions
+ + +## Example +```sql +SELECT +region, +model_card_name +FROM awscc.sagemaker.model_cards +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definition/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definition/index.md new file mode 100644 index 0000000000..d7f77212f5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definition/index.md @@ -0,0 +1,83 @@ +--- +title: model_explainability_job_definition +hide_title: false +hide_table_of_contents: false +keywords: + - model_explainability_job_definition + - 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 +--- +Gets an individual model_explainability_job_definition resource + +## Overview + + + + + +
Namemodel_explainability_job_definition
TypeResource
Descriptionmodel_explainability_job_definition
Idawscc.sagemaker.model_explainability_job_definition
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
model_explainability_baseline_configobject
model_explainability_app_specificationobject
model_explainability_job_inputobject
model_explainability_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_explainability_job_definition resource, the following permissions are required: + +### Delete +
+sagemaker:DeleteModelExplainabilityJobDefinition
+ +### Read +
+sagemaker:DescribeModelExplainabilityJobDefinition
+ + +## Example +```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, +tags, +creation_time +FROM awscc.sagemaker.model_explainability_job_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<JobDefinitionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definitions/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definitions/index.md new file mode 100644 index 0000000000..8eff61b7e4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definitions/index.md @@ -0,0 +1,62 @@ +--- +title: model_explainability_job_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - model_explainability_job_definitions + - 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 +--- +Retrieves a list of model_explainability_job_definitions in a region + +## Overview + + + + + +
Namemodel_explainability_job_definitions
TypeResource
Descriptionmodel_explainability_job_definitions
Idawscc.sagemaker.model_explainability_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_explainability_job_definitions resource, the following permissions are required: + +### Create +
+sagemaker:CreateModelExplainabilityJobDefinition,
+sagemaker:DescribeModelExplainabilityJobDefinition,
+iam:PassRole,
+sagemaker:AddTags
+ +### List +
+sagemaker:ListModelExplainabilityJobDefinitions,
+sagemaker:ListTags
+ + +## Example +```sql +SELECT +region, +job_definition_arn +FROM awscc.sagemaker.model_explainability_job_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md new file mode 100644 index 0000000000..8f8b0c0bc8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md @@ -0,0 +1,121 @@ +--- +title: model_package +hide_title: false +hide_table_of_contents: false +keywords: + - model_package + - 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 +--- +Gets an individual model_package resource + +## Overview + + + + + +
Namemodel_package
TypeResource
Descriptionmodel_package
Idawscc.sagemaker.model_package
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
additional_inference_specificationsarray
certify_for_marketplaceboolean
client_tokenstring
customer_metadata_propertiesobject
domainstring
drift_check_baselinesobject
inference_specificationobject
metadata_propertiesobject
model_approval_statusstring
model_metricsobject
model_package_descriptionstring
model_package_group_namestring
model_package_namestring
sample_payload_urlstring
skip_model_validationstring
source_algorithm_specificationobject
taskstring
validation_specificationobject
model_package_arnstring
approval_descriptionstring
creation_timestring
last_modified_timestring
model_package_statusstring
model_package_versioninteger
additional_inference_specifications_to_addarray
model_package_status_detailsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_package resource, the following permissions are required: + +### Read +
+sagemaker:DescribeModelPackage,
+sagemaker:ListTags
+ +### Update +
+sagemaker:UpdateModelPackage,
+sagemaker:DescribeModelPackage,
+sagemaker:ListTags,
+sagemaker:AddTags,
+sagemaker:DeleteTags
+ +### Delete +
+sagemaker:DeleteModelPackage,
+sagemaker:DescribeModelPackage
+ + +## Example +```sql +SELECT +region, +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 awscc.sagemaker.model_package +WHERE region = 'us-east-1' +AND data__Identifier = '<ModelPackageArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_package_group/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_package_group/index.md new file mode 100644 index 0000000000..9ff31039c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_package_group/index.md @@ -0,0 +1,87 @@ +--- +title: model_package_group +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_group + - 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 +--- +Gets an individual model_package_group resource + +## Overview + + + + + +
Namemodel_package_group
TypeResource
Descriptionmodel_package_group
Idawscc.sagemaker.model_package_group
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
model_package_group_arnstring
model_package_group_namestring
model_package_group_descriptionstring
model_package_group_policyobject
creation_timestringThe time at which the model package group was created.
model_package_group_statusstringThe status of a modelpackage group job.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_package_group resource, the following permissions are required: + +### Delete +
+sagemaker:DeleteModelPackageGroup,
+sagemaker:DescribeModelPackageGroup,
+sagemaker:GetModelPackageGroupPolicy,
+sagemaker:DeleteModelPackageGroupPolicy
+ +### Read +
+sagemaker:DescribeModelPackageGroup,
+sagemaker:GetModelPackageGroupPolicy,
+sagemaker:PutModelPackageGroupPolicy,
+sagemaker:ListTags
+ +### Update +
+sagemaker:DescribeModelPackageGroup,
+sagemaker:GetModelPackageGroupPolicy,
+sagemaker:DeleteModelPackageGroupPolicy,
+sagemaker:PutModelPackageGroupPolicy,
+sagemaker:ListTags,
+sagemaker:AddTags,
+sagemaker:DeleteTags
+ + +## Example +```sql +SELECT +region, +tags, +model_package_group_arn, +model_package_group_name, +model_package_group_description, +model_package_group_policy, +creation_time, +model_package_group_status +FROM awscc.sagemaker.model_package_group +WHERE region = 'us-east-1' +AND data__Identifier = '<ModelPackageGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_package_groups/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_package_groups/index.md new file mode 100644 index 0000000000..e137aec44d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_package_groups/index.md @@ -0,0 +1,63 @@ +--- +title: model_package_groups +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_groups + - 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 +--- +Retrieves a list of model_package_groups in a region + +## Overview + + + + + +
Namemodel_package_groups
TypeResource
Descriptionmodel_package_groups
Idawscc.sagemaker.model_package_groups
+ +## Fields + + + + + +
NameDatatypeDescription
model_package_group_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_package_groups resource, the following permissions are required: + +### Create +
+sagemaker:CreateModelPackageGroup,
+sagemaker:DescribeModelPackageGroup,
+sagemaker:GetModelPackageGroupPolicy,
+sagemaker:PutModelPackageGroupPolicy,
+sagemaker:ListTags,
+sagemaker:AddTags
+ +### List +
+sagemaker:ListModelPackageGroups
+ + +## Example +```sql +SELECT +region, +model_package_group_arn +FROM awscc.sagemaker.model_package_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md new file mode 100644 index 0000000000..84a22fefb1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md @@ -0,0 +1,71 @@ +--- +title: model_packages +hide_title: false +hide_table_of_contents: false +keywords: + - model_packages + - 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 +--- +Retrieves a list of model_packages in a region + +## Overview + + + + + +
Namemodel_packages
TypeResource
Descriptionmodel_packages
Idawscc.sagemaker.model_packages
+ +## Fields + + + + + +
NameDatatypeDescription
model_package_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_packages resource, the following permissions are required: + +### Create +
+ecr:BatchGetImage,
+ecr:DescribeImages,
+ecr:StartImageScan,
+ecr:DescribeImageScanFindings,
+sagemaker:AddTags,
+sagemaker:CreateModel,
+sagemaker:CreateModelPackage,
+sagemaker:CreateTrainingJob,
+sagemaker:CreateTransformJob,
+sagemaker:DescribeTransformJob,
+sagemaker:DescribeModelPackage,
+sagemaker:ListTags,
+iam:PassRole,
+s3:GetObject
+ +### List +
+sagemaker:ListModelPackages
+ + +## Example +```sql +SELECT +region, +model_package_arn +FROM awscc.sagemaker.model_packages +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definition/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definition/index.md new file mode 100644 index 0000000000..dda7159b64 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definition/index.md @@ -0,0 +1,83 @@ +--- +title: model_quality_job_definition +hide_title: false +hide_table_of_contents: false +keywords: + - model_quality_job_definition + - 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 +--- +Gets an individual model_quality_job_definition resource + +## Overview + + + + + +
Namemodel_quality_job_definition
TypeResource
Descriptionmodel_quality_job_definition
Idawscc.sagemaker.model_quality_job_definition
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
job_definition_namestring
model_quality_baseline_configobject
model_quality_app_specificationobject
model_quality_job_inputobject
model_quality_job_output_configobject
job_resourcesobject
network_configobject
endpoint_namestring
role_arnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stopping_conditionobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the job definition was created.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_quality_job_definition resource, the following permissions are required: + +### Delete +
+sagemaker:DeleteModelQualityJobDefinition
+ +### Read +
+sagemaker:DescribeModelQualityJobDefinition
+ + +## Example +```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, +tags, +creation_time +FROM awscc.sagemaker.model_quality_job_definition +WHERE region = 'us-east-1' +AND data__Identifier = '<JobDefinitionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definitions/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definitions/index.md new file mode 100644 index 0000000000..6411f0a5b1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definitions/index.md @@ -0,0 +1,62 @@ +--- +title: model_quality_job_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - model_quality_job_definitions + - 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 +--- +Retrieves a list of model_quality_job_definitions in a region + +## Overview + + + + + +
Namemodel_quality_job_definitions
TypeResource
Descriptionmodel_quality_job_definitions
Idawscc.sagemaker.model_quality_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the model_quality_job_definitions resource, the following permissions are required: + +### Create +
+sagemaker:CreateModelQualityJobDefinition,
+sagemaker:DescribeModelQualityJobDefinition,
+sagemaker:AddTags,
+iam:PassRole
+ +### List +
+sagemaker:ListModelQualityJobDefinitions,
+sagemaker:ListTags
+ + +## Example +```sql +SELECT +region, +job_definition_arn +FROM awscc.sagemaker.model_quality_job_definitions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md b/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md new file mode 100644 index 0000000000..00badce197 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md @@ -0,0 +1,83 @@ +--- +title: monitoring_schedule +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_schedule + - 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 +--- +Gets an individual monitoring_schedule resource + +## Overview + + + + + +
Namemonitoring_schedule
TypeResource
Descriptionmonitoring_schedule
Idawscc.sagemaker.monitoring_schedule
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
monitoring_schedule_arnstringThe Amazon Resource Name (ARN) of the monitoring schedule.
monitoring_schedule_namestring
monitoring_schedule_configobject
tagsarrayAn array of key-value pairs to apply to this resource.
creation_timestringThe time at which the schedule was created.
endpoint_namestring
failure_reasonstringContains the reason a monitoring job failed, if it failed.
last_modified_timestringA timestamp that indicates the last time the monitoring job was modified.
last_monitoring_execution_summaryobjectDescribes metadata on the last execution to run, if there was one.
monitoring_schedule_statusstringThe status of a schedule job.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the monitoring_schedule resource, the following permissions are required: + +### Delete +
+sagemaker:DeleteMonitoringSchedule,
+sagemaker:DescribeMonitoringSchedule
+ +### Read +
+sagemaker:DescribeMonitoringSchedule
+ +### Update +
+sagemaker:UpdateMonitoringSchedule,
+sagemaker:DescribeMonitoringSchedule
+ + +## Example +```sql +SELECT +region, +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 awscc.sagemaker.monitoring_schedule +WHERE region = 'us-east-1' +AND data__Identifier = '<MonitoringScheduleArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md b/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md new file mode 100644 index 0000000000..cfc6c13b5f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md @@ -0,0 +1,60 @@ +--- +title: monitoring_schedules +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_schedules + - 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 +--- +Retrieves a list of monitoring_schedules in a region + +## Overview + + + + + +
Namemonitoring_schedules
TypeResource
Descriptionmonitoring_schedules
Idawscc.sagemaker.monitoring_schedules
+ +## Fields + + + + + +
NameDatatypeDescription
monitoring_schedule_arnstringThe Amazon Resource Name (ARN) of the monitoring schedule.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the monitoring_schedules resource, the following permissions are required: + +### Create +
+sagemaker:CreateMonitoringSchedule,
+sagemaker:DescribeMonitoringSchedule,
+iam:PassRole
+ +### List +
+sagemaker:ListMonitoringSchedule
+ + +## Example +```sql +SELECT +region, +monitoring_schedule_arn +FROM awscc.sagemaker.monitoring_schedules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md b/docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md new file mode 100644 index 0000000000..e939d5fda6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md @@ -0,0 +1,82 @@ +--- +title: pipeline +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline + - 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 +--- +Gets an individual pipeline resource + +## Overview + + + + + +
Namepipeline
TypeResource
Descriptionpipeline
Idawscc.sagemaker.pipeline
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
pipeline_namestringThe name of the Pipeline.
pipeline_display_namestringThe display name of the Pipeline.
pipeline_descriptionstringThe description of the Pipeline.
pipeline_definitionobject
role_arnstringRole Arn
tagsarray
parallelism_configurationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +
+sagemaker:DescribePipeline,
+sagemaker:ListTags
+ +### Update +
+iam:PassRole,
+s3:GetObject,
+sagemaker:UpdatePipeline,
+sagemaker:DescribePipeline,
+sagemaker:AddTags,
+sagemaker:DeleteTags,
+sagemaker:ListTags
+ +### Delete +
+sagemaker:DeletePipeline
+ + +## Example +```sql +SELECT +region, +pipeline_name, +pipeline_display_name, +pipeline_description, +pipeline_definition, +role_arn, +tags, +parallelism_configuration +FROM awscc.sagemaker.pipeline +WHERE region = 'us-east-1' +AND data__Identifier = '<PipelineName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md b/docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md new file mode 100644 index 0000000000..551cac51d3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md @@ -0,0 +1,63 @@ +--- +title: pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines + - 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 +--- +Retrieves a list of pipelines in a region + +## Overview + + + + + +
Namepipelines
TypeResource
Descriptionpipelines
Idawscc.sagemaker.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_namestringThe name of the Pipeline.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +
+iam:PassRole,
+s3:GetObject,
+sagemaker:CreatePipeline,
+sagemaker:DescribePipeline,
+sagemaker:AddTags,
+sagemaker:ListTags
+ +### List +
+sagemaker:ListPipelines
+ + +## Example +```sql +SELECT +region, +pipeline_name +FROM awscc.sagemaker.pipelines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/project/index.md b/docs/awscc-docs/providers/awscc/sagemaker/project/index.md new file mode 100644 index 0000000000..aa3e6311fd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/project/index.md @@ -0,0 +1,86 @@ +--- +title: project +hide_title: false +hide_table_of_contents: false +keywords: + - project + - 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 +--- +Gets an individual project resource + +## Overview + + + + + +
Nameproject
TypeResource
Descriptionproject
Idawscc.sagemaker.project
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
tagsarrayAn array of key-value pairs to apply to this resource.
project_arnstring
project_idstring
project_namestring
project_descriptionstring
creation_timestringThe time at which the project was created.
service_catalog_provisioning_detailsobjectInput ServiceCatalog Provisioning Details
service_catalog_provisioned_product_detailsobjectProvisioned ServiceCatalog Details
project_statusstringThe status of a project.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +
+sagemaker:DescribeProject,
+sagemaker:ListTags
+ +### Update +
+sagemaker:DescribeProject,
+sagemaker:ListTags,
+sagemaker:AddTags,
+sagemaker:DeleteTags
+ +### Delete +
+sagemaker:DeleteProject,
+sagemaker:DescribeProject,
+servicecatalog:TerminateProvisionedProduct,
+servicecatalog:DescribeRecord
+ + +## Example +```sql +SELECT +region, +tags, +project_arn, +project_id, +project_name, +project_description, +creation_time, +service_catalog_provisioning_details, +service_catalog_provisioned_product_details, +project_status +FROM awscc.sagemaker.project +WHERE region = 'us-east-1' +AND data__Identifier = '<ProjectArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/projects/index.md b/docs/awscc-docs/providers/awscc/sagemaker/projects/index.md new file mode 100644 index 0000000000..fd8a67b907 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/projects/index.md @@ -0,0 +1,66 @@ +--- +title: projects +hide_title: false +hide_table_of_contents: false +keywords: + - projects + - 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 +--- +Retrieves a list of projects in a region + +## Overview + + + + + +
Nameprojects
TypeResource
Descriptionprojects
Idawscc.sagemaker.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +
+sagemaker:AddTags,
+sagemaker:CreateProject,
+sagemaker:DescribeProject,
+sagemaker:ListTags,
+servicecatalog:DescribeProduct,
+servicecatalog:DescribeProvisioningArtifact,
+servicecatalog:ProvisionProduct,
+servicecatalog:DescribeProvisionedProduct,
+servicecatalog:TerminateProvisionedProduct
+ +### List +
+sagemaker:ListProjects
+ + +## Example +```sql +SELECT +region, +project_arn +FROM awscc.sagemaker.projects +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/space/index.md b/docs/awscc-docs/providers/awscc/sagemaker/space/index.md new file mode 100644 index 0000000000..435619550f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/space/index.md @@ -0,0 +1,82 @@ +--- +title: space +hide_title: false +hide_table_of_contents: false +keywords: + - space + - 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 +--- +Gets an individual space resource + +## Overview + + + + + +
Namespace
TypeResource
Descriptionspace
Idawscc.sagemaker.space
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
space_arnstringThe space Amazon Resource Name (ARN).
domain_idstringThe ID of the associated Domain.
space_namestringA name for the Space.
space_settingsobjectA collection of settings.
tagsarrayA list of tags to apply to the space.
ownership_settingsobject
space_sharing_settingsobject
space_display_namestring
urlstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the space resource, the following permissions are required: + +### Read +
+sagemaker:DescribeSpace
+ +### Update +
+sagemaker:UpdateSpace,
+sagemaker:DescribeSpace
+ +### Delete +
+sagemaker:DeleteSpace,
+sagemaker:DescribeSpace
+ + +## Example +```sql +SELECT +region, +space_arn, +domain_id, +space_name, +space_settings, +tags, +ownership_settings, +space_sharing_settings, +space_display_name, +url +FROM awscc.sagemaker.space +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +AND data__Identifier = '<SpaceName>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md b/docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md new file mode 100644 index 0000000000..b5d1776c68 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md @@ -0,0 +1,61 @@ +--- +title: spaces +hide_title: false +hide_table_of_contents: false +keywords: + - spaces + - 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 +--- +Retrieves a list of spaces in a region + +## Overview + + + + + +
Namespaces
TypeResource
Descriptionspaces
Idawscc.sagemaker.spaces
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstringThe ID of the associated Domain.
space_namestringA name for the Space.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the spaces resource, the following permissions are required: + +### Create +
+sagemaker:CreateSpace,
+sagemaker:DescribeSpace
+ +### List +
+sagemaker:ListSpaces
+ + +## Example +```sql +SELECT +region, +domain_id, +space_name +FROM awscc.sagemaker.spaces +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md b/docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md new file mode 100644 index 0000000000..93b0a18d48 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md @@ -0,0 +1,81 @@ +--- +title: user_profile +hide_title: false +hide_table_of_contents: false +keywords: + - user_profile + - 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 +--- +Gets an individual user_profile resource + +## Overview + + + + + +
Nameuser_profile
TypeResource
Descriptionuser_profile
Idawscc.sagemaker.user_profile
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
user_profile_arnstringThe user profile Amazon Resource Name (ARN).
domain_idstringThe ID of the associated Domain.
single_sign_on_user_identifierstringA 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.
single_sign_on_user_valuestringThe 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.
user_profile_namestringA name for the UserProfile.
user_settingsobjectA collection of settings.
tagsarrayA list of tags to apply to the user profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_profile resource, the following permissions are required: + +### Read +
+sagemaker:DescribeUserProfile
+ +### Update +
+sagemaker:UpdateUserProfile,
+sagemaker:DescribeUserProfile,
+sagemaker:DescribeImage,
+sagemaker:DescribeImageVersion,
+iam:PassRole
+ +### Delete +
+sagemaker:DeleteUserProfile,
+sagemaker:DescribeUserProfile
+ + +## Example +```sql +SELECT +region, +user_profile_arn, +domain_id, +single_sign_on_user_identifier, +single_sign_on_user_value, +user_profile_name, +user_settings, +tags +FROM awscc.sagemaker.user_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<UserProfileName>' +AND data__Identifier = '<DomainId>' +``` diff --git a/docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md b/docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md new file mode 100644 index 0000000000..2f7f09d6bd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md @@ -0,0 +1,64 @@ +--- +title: user_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - user_profiles + - 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 +--- +Retrieves a list of user_profiles in a region + +## Overview + + + + + +
Nameuser_profiles
TypeResource
Descriptionuser_profiles
Idawscc.sagemaker.user_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
user_profile_namestringA name for the UserProfile.
domain_idstringThe ID of the associated Domain.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_profiles resource, the following permissions are required: + +### Create +
+sagemaker:CreateUserProfile,
+sagemaker:DescribeUserProfile,
+sagemaker:DescribeImage,
+sagemaker:DescribeImageVersion,
+iam:PassRole
+ +### List +
+sagemaker:ListUserProfiles
+ + +## Example +```sql +SELECT +region, +user_profile_name, +domain_id +FROM awscc.sagemaker.user_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/scheduler/index.md b/docs/awscc-docs/providers/awscc/scheduler/index.md new file mode 100644 index 0000000000..239c23a5ea --- /dev/null +++ b/docs/awscc-docs/providers/awscc/scheduler/index.md @@ -0,0 +1,41 @@ +--- +title: scheduler +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The scheduler service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+schedule
+schedule_group +
+
+schedule_groups
+schedules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/scheduler/schedule/index.md b/docs/awscc-docs/providers/awscc/scheduler/schedule/index.md new file mode 100644 index 0000000000..f26aedc077 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/scheduler/schedule/index.md @@ -0,0 +1,88 @@ +--- +title: schedule +hide_title: false +hide_table_of_contents: false +keywords: + - schedule + - 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 +--- +Gets an individual schedule resource + +## Overview + + + + + +
Nameschedule
TypeResource
Descriptionschedule
Idawscc.scheduler.schedule
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the schedule.
descriptionstringThe description of the schedule.
end_datestringThe 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.
flexible_time_windowobject
group_namestringThe name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kms_key_arnstringThe ARN for a KMS Key that will be used to encrypt customer data.
namestring
schedule_expressionstringThe scheduling expression.
schedule_expression_timezonestringThe timezone in which the scheduling expression is evaluated.
start_datestringThe 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.
statestring
targetobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schedule resource, the following permissions are required: + +### Read +
+scheduler:GetSchedule
+ +### Update +
+scheduler:UpdateSchedule,
+scheduler:GetSchedule,
+iam:PassRole
+ +### Delete +
+scheduler:DeleteSchedule,
+scheduler:GetSchedule
+ + +## Example +```sql +SELECT +region, +arn, +description, +end_date, +flexible_time_window, +group_name, +kms_key_arn, +name, +schedule_expression, +schedule_expression_timezone, +start_date, +state, +target +FROM awscc.scheduler.schedule +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md b/docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md new file mode 100644 index 0000000000..a8a348e937 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md @@ -0,0 +1,79 @@ +--- +title: schedule_group +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_group + - 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 +--- +Gets an individual schedule_group resource + +## Overview + + + + + +
Nameschedule_group
TypeResource
Descriptionschedule_group
Idawscc.scheduler.schedule_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the schedule group.
creation_datestringThe time at which the schedule group was created.
last_modification_datestringThe time at which the schedule group was last modified.
namestring
statestring
tagsarrayThe list of tags to associate with the schedule group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schedule_group resource, the following permissions are required: + +### Read +
+scheduler:GetScheduleGroup,
+scheduler:ListTagsForResource
+ +### Update +
+scheduler:TagResource,
+scheduler:UntagResource,
+scheduler:ListTagsForResource,
+scheduler:GetScheduleGroup
+ +### Delete +
+scheduler:DeleteScheduleGroup,
+scheduler:GetScheduleGroup,
+scheduler:DeleteSchedule
+ + +## Example +```sql +SELECT +region, +arn, +creation_date, +last_modification_date, +name, +state, +tags +FROM awscc.scheduler.schedule_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md b/docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md new file mode 100644 index 0000000000..a48a1e5f3e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md @@ -0,0 +1,61 @@ +--- +title: schedule_groups +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_groups + - 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 +--- +Retrieves a list of schedule_groups in a region + +## Overview + + + + + +
Nameschedule_groups
TypeResource
Descriptionschedule_groups
Idawscc.scheduler.schedule_groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schedule_groups resource, the following permissions are required: + +### Create +
+scheduler:TagResource,
+scheduler:CreateScheduleGroup,
+scheduler:GetScheduleGroup,
+scheduler:ListTagsForResource
+ +### List +
+scheduler:ListScheduleGroups
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.scheduler.schedule_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/scheduler/schedules/index.md b/docs/awscc-docs/providers/awscc/scheduler/schedules/index.md new file mode 100644 index 0000000000..98a464fd61 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/scheduler/schedules/index.md @@ -0,0 +1,60 @@ +--- +title: schedules +hide_title: false +hide_table_of_contents: false +keywords: + - schedules + - 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 +--- +Retrieves a list of schedules in a region + +## Overview + + + + + +
Nameschedules
TypeResource
Descriptionschedules
Idawscc.scheduler.schedules
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the schedules resource, the following permissions are required: + +### Create +
+scheduler:CreateSchedule,
+scheduler:GetSchedule,
+iam:PassRole
+ +### List +
+scheduler:ListSchedules
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.scheduler.schedules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/secretsmanager/index.md b/docs/awscc-docs/providers/awscc/secretsmanager/index.md new file mode 100644 index 0000000000..0895daf3a0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/secretsmanager/index.md @@ -0,0 +1,39 @@ +--- +title: secretsmanager +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The secretsmanager service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+secret +
+
+secrets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/secretsmanager/secret/index.md b/docs/awscc-docs/providers/awscc/secretsmanager/secret/index.md new file mode 100644 index 0000000000..3e38baaec7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/secretsmanager/secret/index.md @@ -0,0 +1,86 @@ +--- +title: secret +hide_title: false +hide_table_of_contents: false +keywords: + - secret + - 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 +--- +Gets an individual secret resource + +## Overview + + + + + +
Namesecret
TypeResource
Descriptionsecret
Idawscc.secretsmanager.secret
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description of the secret.
kms_key_idstringThe 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).<br/> To use a KMS key in a different account, use the key ARN or the alias ARN.<br/> 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.<br/> 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.
secret_stringstringThe 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.
generate_secret_stringobjectA 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.<br/> We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
replica_regionsarrayA custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
idstring
tagsarrayA 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:<br/> ``[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]`` <br/> Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".<br/> Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. <br/> 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.amazo
namestringThe name of the new secret.<br/> The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-<br/> 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the secret resource, the following permissions are required: + +### Delete +
+secretsmanager:DeleteSecret,
+secretsmanager:DescribeSecret,
+secretsmanager:RemoveRegionsFromReplication
+ +### Read +
+secretsmanager:DescribeSecret,
+secretsmanager:GetSecretValue
+ +### Update +
+secretsmanager:UpdateSecret,
+secretsmanager:TagResource,
+secretsmanager:UntagResource,
+secretsmanager:GetRandomPassword,
+secretsmanager:GetSecretValue,
+secretsmanager:ReplicateSecretToRegions,
+secretsmanager:RemoveRegionsFromReplication
+ + +## Example +```sql +SELECT +region, +description, +kms_key_id, +secret_string, +generate_secret_string, +replica_regions, +id, +tags, +name +FROM awscc.secretsmanager.secret +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md b/docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md new file mode 100644 index 0000000000..015e982514 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md @@ -0,0 +1,61 @@ +--- +title: secrets +hide_title: false +hide_table_of_contents: false +keywords: + - secrets + - 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 +--- +Retrieves a list of secrets in a region + +## Overview + + + + + +
Namesecrets
TypeResource
Descriptionsecrets
Idawscc.secretsmanager.secrets
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the secrets resource, the following permissions are required: + +### Create +
+secretsmanager:DescribeSecret,
+secretsmanager:GetRandomPassword,
+secretsmanager:CreateSecret,
+secretsmanager:TagResource
+ +### List +
+secretsmanager:ListSecrets
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.secretsmanager.secrets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md b/docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md new file mode 100644 index 0000000000..3f1ea71678 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md @@ -0,0 +1,91 @@ +--- +title: automation_rule +hide_title: false +hide_table_of_contents: false +keywords: + - automation_rule + - 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 +--- +Gets an individual automation_rule resource + +## Overview + + + + + +
Nameautomation_rule
TypeResource
Descriptionautomation_rule
Idawscc.securityhub.automation_rule
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
rule_arnstring
rule_statusstringWhether 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.
rule_orderinteger
descriptionstring
rule_namestring
created_atstring
updated_atstring
created_bystring
is_terminalboolean
actionsarray
criteriaobjectA 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.
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the automation_rule resource, the following permissions are required: + +### Read +
+securityhub:ListAutomationRules,
+securityhub:BatchGetAutomationRules,
+securityhub:ListTagsForResource
+ +### Update +
+securityhub:BatchUpdateAutomationRules,
+securityhub:TagResource,
+securityhub:UntagResource,
+securityhub:ListTagsForResource
+ +### Delete +
+securityhub:BatchDeleteAutomationRules,
+securityhub:BatchGetAutomationRules
+ + +## Example +```sql +SELECT +region, +rule_arn, +rule_status, +rule_order, +description, +rule_name, +created_at, +updated_at, +created_by, +is_terminal, +actions, +criteria, +tags +FROM awscc.securityhub.automation_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<RuleArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md b/docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md new file mode 100644 index 0000000000..8a2fd7c42b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md @@ -0,0 +1,61 @@ +--- +title: automation_rules +hide_title: false +hide_table_of_contents: false +keywords: + - automation_rules + - 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 +--- +Retrieves a list of automation_rules in a region + +## Overview + + + + + +
Nameautomation_rules
TypeResource
Descriptionautomation_rules
Idawscc.securityhub.automation_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the automation_rules resource, the following permissions are required: + +### Create +
+securityhub:CreateAutomationRule,
+securityhub:TagResource,
+securityhub:ListTagsForResource
+ +### List +
+securityhub:ListAutomationRules,
+securityhub:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +rule_arn +FROM awscc.securityhub.automation_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/securityhub/hub/index.md b/docs/awscc-docs/providers/awscc/securityhub/hub/index.md new file mode 100644 index 0000000000..e456632153 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/securityhub/hub/index.md @@ -0,0 +1,78 @@ +--- +title: hub +hide_title: false +hide_table_of_contents: false +keywords: + - hub + - 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 +--- +Gets an individual hub resource + +## Overview + + + + + +
Namehub
TypeResource
Descriptionhub
Idawscc.securityhub.hub
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
a_rnstringAn ARN is automatically created for the customer.
enable_default_standardsbooleanWhether to enable the security standards that Security Hub has designated as automatically enabled.
control_finding_generatorstringThis 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.
auto_enable_controlsbooleanWhether to automatically enable new controls when they are added to standards that are enabled
tagsobject
subscribed_atstringThe date and time when Security Hub was enabled in the account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hub resource, the following permissions are required: + +### Read +
+securityhub:DescribeHub,
+securityhub:ListTagsForResource
+ +### Update +
+securityhub:DescribeHub,
+securityhub:UpdateSecurityHubConfiguration,
+securityhub:TagResource,
+securityhub:UntagResource,
+securityhub:ListTagsForResource
+ +### Delete +
+securityhub:DisableSecurityHub
+ + +## Example +```sql +SELECT +region, +a_rn, +enable_default_standards, +control_finding_generator, +auto_enable_controls, +tags, +subscribed_at +FROM awscc.securityhub.hub +WHERE region = 'us-east-1' +AND data__Identifier = '<ARN>' +``` diff --git a/docs/awscc-docs/providers/awscc/securityhub/hubs/index.md b/docs/awscc-docs/providers/awscc/securityhub/hubs/index.md new file mode 100644 index 0000000000..45df86bf89 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/securityhub/hubs/index.md @@ -0,0 +1,62 @@ +--- +title: hubs +hide_title: false +hide_table_of_contents: false +keywords: + - hubs + - 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 +--- +Retrieves a list of hubs in a region + +## Overview + + + + + +
Namehubs
TypeResource
Descriptionhubs
Idawscc.securityhub.hubs
+ +## Fields + + + + + +
NameDatatypeDescription
a_rnstringAn ARN is automatically created for the customer.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the hubs resource, the following permissions are required: + +### Create +
+securityhub:EnableSecurityHub,
+securityhub:UpdateSecurityHubConfiguration,
+securityhub:TagResource,
+securityhub:ListTagsForResource
+ +### List +
+securityhub:DescribeHub,
+securityhub:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +a_rn +FROM awscc.securityhub.hubs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/securityhub/index.md b/docs/awscc-docs/providers/awscc/securityhub/index.md new file mode 100644 index 0000000000..86c03e0078 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/securityhub/index.md @@ -0,0 +1,43 @@ +--- +title: securityhub +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The securityhub service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+automation_rule
+automation_rules
+hub +
+
+hubs
+standard
+standards +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/securityhub/standard/index.md b/docs/awscc-docs/providers/awscc/securityhub/standard/index.md new file mode 100644 index 0000000000..9f10ab55e3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/securityhub/standard/index.md @@ -0,0 +1,70 @@ +--- +title: standard +hide_title: false +hide_table_of_contents: false +keywords: + - standard + - 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 +--- +Gets an individual standard resource + +## Overview + + + + + +
Namestandard
TypeResource
Descriptionstandard
Idawscc.securityhub.standard
+ +## Fields + + + + + + + +
NameDatatypeDescription
standards_subscription_arnstring
standards_arnstringThe 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.
disabled_standards_controlsarraySpecifies which controls are to be disabled in a standard. <br/> *Maximum*: ``100``
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the standard resource, the following permissions are required: + +### Read +
+securityhub:GetEnabledStandards,
+securityhub:DescribeStandardsControls
+ +### Update +
+securityhub:GetEnabledStandards,
+securityhub:UpdateStandardsControl
+ +### Delete +
+securityhub:GetEnabledStandards,
+securityhub:BatchDisableStandards
+ + +## Example +```sql +SELECT +region, +standards_subscription_arn, +standards_arn, +disabled_standards_controls +FROM awscc.securityhub.standard +WHERE region = 'us-east-1' +AND data__Identifier = '<StandardsSubscriptionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/securityhub/standards/index.md b/docs/awscc-docs/providers/awscc/securityhub/standards/index.md new file mode 100644 index 0000000000..009f0f5ea6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/securityhub/standards/index.md @@ -0,0 +1,60 @@ +--- +title: standards +hide_title: false +hide_table_of_contents: false +keywords: + - standards + - 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 +--- +Retrieves a list of standards in a region + +## Overview + + + + + +
Namestandards
TypeResource
Descriptionstandards
Idawscc.securityhub.standards
+ +## Fields + + + + + +
NameDatatypeDescription
standards_subscription_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the standards resource, the following permissions are required: + +### Create +
+securityhub:GetEnabledStandards,
+securityhub:BatchEnableStandards,
+securityhub:UpdateStandardsControl
+ +### List +
+securityhub:GetEnabledStandards
+ + +## Example +```sql +SELECT +region, +standards_subscription_arn +FROM awscc.securityhub.standards +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_product/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_product/index.md new file mode 100644 index 0000000000..41b51b3c42 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_product/index.md @@ -0,0 +1,93 @@ +--- +title: cloud_formation_provisioned_product +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_formation_provisioned_product + - 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 +--- +Gets an individual cloud_formation_provisioned_product resource + +## Overview + + + + + +
Namecloud_formation_provisioned_product
TypeResource
Descriptioncloud_formation_provisioned_product
Idawscc.servicecatalog.cloud_formation_provisioned_product
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
accept_languagestring
notification_arnsarray
path_idstring
path_namestring
product_idstring
product_namestring
provisioned_product_namestring
provisioning_artifact_idstring
provisioning_artifact_namestring
provisioning_parametersarray
provisioning_preferencesobject
tagsarray
provisioned_product_idstring
record_idstring
cloudformation_stack_arnstring
outputsobjectList of key-value pair outputs.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cloud_formation_provisioned_product resource, the following permissions are required: + +### Read +
+*
+ +### Update +
+*
+ +### Delete +
+*
+ + +## Example +```sql +SELECT +region, +accept_language, +notification_arns, +path_id, +path_name, +product_id, +product_name, +provisioned_product_name, +provisioning_artifact_id, +provisioning_artifact_name, +provisioning_parameters, +provisioning_preferences, +tags, +provisioned_product_id, +record_id, +cloudformation_stack_arn, +outputs +FROM awscc.servicecatalog.cloud_formation_provisioned_product +WHERE region = 'us-east-1' +AND data__Identifier = '<ProvisionedProductId>' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_products/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_products/index.md new file mode 100644 index 0000000000..092eb4a5a9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_products/index.md @@ -0,0 +1,54 @@ +--- +title: cloud_formation_provisioned_products +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_formation_provisioned_products + - 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 +--- +Retrieves a list of cloud_formation_provisioned_products in a region + +## Overview + + + + + +
Namecloud_formation_provisioned_products
TypeResource
Descriptioncloud_formation_provisioned_products
Idawscc.servicecatalog.cloud_formation_provisioned_products
+ +## Fields + + + + + +
NameDatatypeDescription
provisioned_product_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the cloud_formation_provisioned_products resource, the following permissions are required: + +### Create +
+*
+ + +## Example +```sql +SELECT +region, +provisioned_product_id +FROM awscc.servicecatalog.cloud_formation_provisioned_products +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/index.md new file mode 100644 index 0000000000..5314a5bd76 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalog/index.md @@ -0,0 +1,43 @@ +--- +title: servicecatalog +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The servicecatalog service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+cloud_formation_provisioned_product
+cloud_formation_provisioned_products
+service_action +
+
+service_action_association
+service_action_associations
+service_actions +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/service_action/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/service_action/index.md new file mode 100644 index 0000000000..c613d58e9c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalog/service_action/index.md @@ -0,0 +1,75 @@ +--- +title: service_action +hide_title: false +hide_table_of_contents: false +keywords: + - service_action + - 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 +--- +Gets an individual service_action resource + +## Overview + + + + + +
Nameservice_action
TypeResource
Descriptionservice_action
Idawscc.servicecatalog.service_action
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
accept_languagestring
namestring
definition_typestring
definitionarray
descriptionstring
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_action resource, the following permissions are required: + +### Read +
+servicecatalog:DescribeServiceAction
+ +### Update +
+servicecatalog:UpdateServiceAction,
+iam:GetRole,
+ssm:DescribeDocument
+ +### Delete +
+servicecatalog:DeleteServiceAction
+ + +## Example +```sql +SELECT +region, +accept_language, +name, +definition_type, +definition, +description, +id +FROM awscc.servicecatalog.service_action +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/service_action_association/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/service_action_association/index.md new file mode 100644 index 0000000000..8c70f9e813 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalog/service_action_association/index.md @@ -0,0 +1,66 @@ +--- +title: service_action_association +hide_title: false +hide_table_of_contents: false +keywords: + - service_action_association + - 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 +--- +Gets an individual service_action_association resource + +## Overview + + + + + +
Nameservice_action_association
TypeResource
Descriptionservice_action_association
Idawscc.servicecatalog.service_action_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
product_idstring
provisioning_artifact_idstring
service_action_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_action_association resource, the following permissions are required: + +### Read +
+servicecatalog:ListServiceActionsForProvisioningArtifact
+ +### Delete +
+servicecatalog:DisassociateServiceActionFromProvisioningArtifact,
+servicecatalog:ListServiceActionsForProvisioningArtifact
+ + +## Example +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM awscc.servicecatalog.service_action_association +WHERE region = 'us-east-1' +AND data__Identifier = '<ProductId>' +AND data__Identifier = '<ProvisioningArtifactId>' +AND data__Identifier = '<ServiceActionId>' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/service_action_associations/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/service_action_associations/index.md new file mode 100644 index 0000000000..28603c7bb1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalog/service_action_associations/index.md @@ -0,0 +1,63 @@ +--- +title: service_action_associations +hide_title: false +hide_table_of_contents: false +keywords: + - service_action_associations + - 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 +--- +Retrieves a list of service_action_associations in a region + +## Overview + + + + + +
Nameservice_action_associations
TypeResource
Descriptionservice_action_associations
Idawscc.servicecatalog.service_action_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
product_idstring
provisioning_artifact_idstring
service_action_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_action_associations resource, the following permissions are required: + +### Create +
+servicecatalog:AssociateServiceActionWithProvisioningArtifact,
+servicecatalog:ListServiceActionsForProvisioningArtifact
+ +### List +
+servicecatalog:ListServiceActionsForProvisioningArtifact
+ + +## Example +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM awscc.servicecatalog.service_action_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md new file mode 100644 index 0000000000..8fff665b53 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md @@ -0,0 +1,60 @@ +--- +title: service_actions +hide_title: false +hide_table_of_contents: false +keywords: + - service_actions + - 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 +--- +Retrieves a list of service_actions in a region + +## Overview + + + + + +
Nameservice_actions
TypeResource
Descriptionservice_actions
Idawscc.servicecatalog.service_actions
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_actions resource, the following permissions are required: + +### Create +
+servicecatalog:CreateServiceAction,
+ssm:DescribeDocument,
+iam:GetRole
+ +### List +
+servicecatalog:ListServiceActions
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.servicecatalog.service_actions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md new file mode 100644 index 0000000000..f9bb37864f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md @@ -0,0 +1,82 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.servicecatalogappregistry.application
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestringThe name of the application.
descriptionstringThe description of the application.
tagsobject
application_tag_keystringThe 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.
application_tag_valuestringThe 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.
application_namestringThe name of the application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+servicecatalog:GetApplication
+ +### Update +
+servicecatalog:GetApplication,
+servicecatalog:ListTagsForResource,
+servicecatalog:TagResource,
+servicecatalog:UntagResource,
+servicecatalog:UpdateApplication,
+iam:CreateServiceLinkedRole
+ +### Delete +
+servicecatalog:DeleteApplication
+ + +## Example +```sql +SELECT +region, +id, +arn, +name, +description, +tags, +application_tag_key, +application_tag_value, +application_name +FROM awscc.servicecatalogappregistry.application +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md new file mode 100644 index 0000000000..de0107ba27 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md @@ -0,0 +1,60 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.servicecatalogappregistry.applications
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+servicecatalog:CreateApplication,
+servicecatalog:TagResource,
+iam:CreateServiceLinkedRole
+ +### List +
+servicecatalog:ListApplications
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.servicecatalogappregistry.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md new file mode 100644 index 0000000000..5518be9c52 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md @@ -0,0 +1,77 @@ +--- +title: attribute_group +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_group + - 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 +--- +Gets an individual attribute_group resource + +## Overview + + + + + +
Nameattribute_group
TypeResource
Descriptionattribute_group
Idawscc.servicecatalogappregistry.attribute_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestringThe name of the attribute group.
descriptionstringThe description of the attribute group.
attributesobject
tagsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the attribute_group resource, the following permissions are required: + +### Read +
+servicecatalog:GetAttributeGroup
+ +### Update +
+servicecatalog:GetAttributeGroup,
+servicecatalog:UpdateAttributeGroup,
+servicecatalog:ListTagsForResource,
+servicecatalog:TagResource,
+servicecatalog:UntagResource
+ +### Delete +
+servicecatalog:DeleteAttributeGroup
+ + +## Example +```sql +SELECT +region, +id, +arn, +name, +description, +attributes, +tags +FROM awscc.servicecatalogappregistry.attribute_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_association/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_association/index.md new file mode 100644 index 0000000000..2a80685fcf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_association/index.md @@ -0,0 +1,66 @@ +--- +title: attribute_group_association +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_group_association + - 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 +--- +Gets an individual attribute_group_association resource + +## Overview + + + + + +
Nameattribute_group_association
TypeResource
Descriptionattribute_group_association
Idawscc.servicecatalogappregistry.attribute_group_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
applicationstringThe name or the Id of the Application.
attribute_groupstringThe name or the Id of the AttributeGroup.
application_arnstring
attribute_group_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the attribute_group_association resource, the following permissions are required: + +### Read +
+servicecatalog:ListAttributeGroupsForApplication
+ +### Delete +
+servicecatalog:DisassociateAttributeGroup
+ + +## Example +```sql +SELECT +region, +application, +attribute_group, +application_arn, +attribute_group_arn +FROM awscc.servicecatalogappregistry.attribute_group_association +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationArn>' +AND data__Identifier = '<AttributeGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_associations/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_associations/index.md new file mode 100644 index 0000000000..2a75f6859a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_associations/index.md @@ -0,0 +1,60 @@ +--- +title: attribute_group_associations +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_group_associations + - 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 +--- +Retrieves a list of attribute_group_associations in a region + +## Overview + + + + + +
Nameattribute_group_associations
TypeResource
Descriptionattribute_group_associations
Idawscc.servicecatalogappregistry.attribute_group_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
application_arnstring
attribute_group_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the attribute_group_associations resource, the following permissions are required: + +### Create +
+servicecatalog:AssociateAttributeGroup
+ +### List +
+servicecatalog:ListAttributeGroupsForApplication
+ + +## Example +```sql +SELECT +region, +application_arn, +attribute_group_arn +FROM awscc.servicecatalogappregistry.attribute_group_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md new file mode 100644 index 0000000000..075485ef71 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md @@ -0,0 +1,59 @@ +--- +title: attribute_groups +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_groups + - 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 +--- +Retrieves a list of attribute_groups in a region + +## Overview + + + + + +
Nameattribute_groups
TypeResource
Descriptionattribute_groups
Idawscc.servicecatalogappregistry.attribute_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the attribute_groups resource, the following permissions are required: + +### Create +
+servicecatalog:CreateAttributeGroup,
+servicecatalog:TagResource
+ +### List +
+servicecatalog:ListAttributeGroups
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.servicecatalogappregistry.attribute_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md new file mode 100644 index 0000000000..6dc87b7a4c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md @@ -0,0 +1,45 @@ +--- +title: servicecatalogappregistry +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The servicecatalogappregistry service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+application
+applications
+attribute_group
+attribute_group_association +
+
+attribute_group_associations
+attribute_groups
+resource_association
+resource_associations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_association/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_association/index.md new file mode 100644 index 0000000000..1e71854407 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_association/index.md @@ -0,0 +1,69 @@ +--- +title: resource_association +hide_title: false +hide_table_of_contents: false +keywords: + - resource_association + - 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 +--- +Gets an individual resource_association resource + +## Overview + + + + + +
Nameresource_association
TypeResource
Descriptionresource_association
Idawscc.servicecatalogappregistry.resource_association
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
applicationstringThe name or the Id of the Application.
resourcestringThe name or the Id of the Resource.
resource_typestringThe type of the CFN Resource for now it's enum CFN_STACK.
application_arnstring
resource_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_association resource, the following permissions are required: + +### Read +
+servicecatalog:ListAssociatedResources
+ +### Delete +
+servicecatalog:DisassociateResource
+ + +## Example +```sql +SELECT +region, +application, +resource, +resource_type, +application_arn, +resource_arn +FROM awscc.servicecatalogappregistry.resource_association +WHERE region = 'us-east-1' +AND data__Identifier = '<ApplicationArn>' +AND data__Identifier = '<ResourceArn>' +AND data__Identifier = '<ResourceType>' +``` diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md new file mode 100644 index 0000000000..f6ff834fbb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md @@ -0,0 +1,63 @@ +--- +title: resource_associations +hide_title: false +hide_table_of_contents: false +keywords: + - resource_associations + - 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 +--- +Retrieves a list of resource_associations in a region + +## Overview + + + + + +
Nameresource_associations
TypeResource
Descriptionresource_associations
Idawscc.servicecatalogappregistry.resource_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
application_arnstring
resource_arnstring
resource_typestringThe type of the CFN Resource for now it's enum CFN_STACK.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_associations resource, the following permissions are required: + +### Create +
+servicecatalog:AssociateResource,
+cloudformation:DescribeStacks
+ +### List +
+servicecatalog:ListAssociatedResources
+ + +## Example +```sql +SELECT +region, +application_arn, +resource_arn, +resource_type +FROM awscc.servicecatalogappregistry.resource_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/configuration_set/index.md b/docs/awscc-docs/providers/awscc/ses/configuration_set/index.md new file mode 100644 index 0000000000..173775f20a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/configuration_set/index.md @@ -0,0 +1,81 @@ +--- +title: configuration_set +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_set + - 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 +--- +Gets an individual configuration_set resource + +## Overview + + + + + +
Nameconfiguration_set
TypeResource
Descriptionconfiguration_set
Idawscc.ses.configuration_set
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the configuration set.
tracking_optionsobject
delivery_optionsobject
reputation_optionsobject
sending_optionsobject
suppression_optionsobject
vdm_optionsobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_set resource, the following permissions are required: + +### Read +
+ses:GetConfigurationSet,
+ses:DescribeConfigurationSet
+ +### Update +
+ses:PutConfigurationSetTrackingOptions,
+ses:PutConfigurationSetDeliveryOptions,
+ses:PutConfigurationSetReputationOptions,
+ses:PutConfigurationSetSendingOptions,
+ses:PutConfigurationSetSuppressionOptions,
+ses:PutConfigurationSetVdmOptions
+ +### Delete +
+ses:DeleteConfigurationSet
+ + +## Example +```sql +SELECT +region, +name, +tracking_options, +delivery_options, +reputation_options, +sending_options, +suppression_options, +vdm_options +FROM awscc.ses.configuration_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/configuration_set_event_destination/index.md b/docs/awscc-docs/providers/awscc/ses/configuration_set_event_destination/index.md new file mode 100644 index 0000000000..67d68b488e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/configuration_set_event_destination/index.md @@ -0,0 +1,69 @@ +--- +title: configuration_set_event_destination +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_set_event_destination + - 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 +--- +Gets an individual configuration_set_event_destination resource + +## Overview + + + + + +
Nameconfiguration_set_event_destination
TypeResource
Descriptionconfiguration_set_event_destination
Idawscc.ses.configuration_set_event_destination
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
configuration_set_namestringThe name of the configuration set that contains the event destination.
event_destinationobjectThe event destination object.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_set_event_destination resource, the following permissions are required: + +### Update +
+ses:UpdateConfigurationSetEventDestination,
+ses:GetConfigurationSetEventDestinations
+ +### Delete +
+ses:DeleteConfigurationSetEventDestination
+ +### Read +
+ses:GetConfigurationSetEventDestinations,
+ses:DescribeConfigurationSet
+ + +## Example +```sql +SELECT +region, +id, +configuration_set_name, +event_destination +FROM awscc.ses.configuration_set_event_destination +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/configuration_set_event_destinations/index.md b/docs/awscc-docs/providers/awscc/ses/configuration_set_event_destinations/index.md new file mode 100644 index 0000000000..a8bc708de7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/configuration_set_event_destinations/index.md @@ -0,0 +1,56 @@ +--- +title: configuration_set_event_destinations +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_set_event_destinations + - 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 +--- +Retrieves a list of configuration_set_event_destinations in a region + +## Overview + + + + + +
Nameconfiguration_set_event_destinations
TypeResource
Descriptionconfiguration_set_event_destinations
Idawscc.ses.configuration_set_event_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_set_event_destinations resource, the following permissions are required: + +### Create +
+ses:CreateConfigurationSetEventDestination,
+ses:GetConfigurationSetEventDestinations,
+ses:DescribeConfigurationSet
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.ses.configuration_set_event_destinations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md b/docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md new file mode 100644 index 0000000000..240372d118 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md @@ -0,0 +1,58 @@ +--- +title: configuration_sets +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_sets + - 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 +--- +Retrieves a list of configuration_sets in a region + +## Overview + + + + + +
Nameconfiguration_sets
TypeResource
Descriptionconfiguration_sets
Idawscc.ses.configuration_sets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the configuration set.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the configuration_sets resource, the following permissions are required: + +### Create +
+ses:CreateConfigurationSet
+ +### List +
+ses:ListConfigurationSets
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.ses.configuration_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/contact_list/index.md b/docs/awscc-docs/providers/awscc/ses/contact_list/index.md new file mode 100644 index 0000000000..301643a05c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/contact_list/index.md @@ -0,0 +1,71 @@ +--- +title: contact_list +hide_title: false +hide_table_of_contents: false +keywords: + - contact_list + - 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 +--- +Gets an individual contact_list resource + +## Overview + + + + + +
Namecontact_list
TypeResource
Descriptioncontact_list
Idawscc.ses.contact_list
+ +## Fields + + + + + + + + +
NameDatatypeDescription
contact_list_namestringThe name of the contact list.
descriptionstringThe description of the contact list.
topicsarrayThe topics associated with the contact list.
tagsarrayThe tags (keys and values) associated with the contact list.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_list resource, the following permissions are required: + +### Read +
+ses:GetContactList
+ +### Update +
+ses:UpdateContactList,
+ses:UntagResource,
+ses:TagResource
+ +### Delete +
+ses:DeleteContactList
+ + +## Example +```sql +SELECT +region, +contact_list_name, +description, +topics, +tags +FROM awscc.ses.contact_list +WHERE region = 'us-east-1' +AND data__Identifier = '<ContactListName>' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/contact_lists/index.md b/docs/awscc-docs/providers/awscc/ses/contact_lists/index.md new file mode 100644 index 0000000000..80e7ae38a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/contact_lists/index.md @@ -0,0 +1,58 @@ +--- +title: contact_lists +hide_title: false +hide_table_of_contents: false +keywords: + - contact_lists + - 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 +--- +Retrieves a list of contact_lists in a region + +## Overview + + + + + +
Namecontact_lists
TypeResource
Descriptioncontact_lists
Idawscc.ses.contact_lists
+ +## Fields + + + + + +
NameDatatypeDescription
contact_list_namestringThe name of the contact list.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_lists resource, the following permissions are required: + +### Create +
+ses:CreateContactList
+ +### List +
+ses:ListContactLists
+ + +## Example +```sql +SELECT +region, +contact_list_name +FROM awscc.ses.contact_lists +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pool/index.md b/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pool/index.md new file mode 100644 index 0000000000..cc5e0b84e2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pool/index.md @@ -0,0 +1,67 @@ +--- +title: dedicated_ip_pool +hide_title: false +hide_table_of_contents: false +keywords: + - dedicated_ip_pool + - 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 +--- +Gets an individual dedicated_ip_pool resource + +## Overview + + + + + +
Namededicated_ip_pool
TypeResource
Descriptiondedicated_ip_pool
Idawscc.ses.dedicated_ip_pool
+ +## Fields + + + + + + +
NameDatatypeDescription
pool_namestringThe name of the dedicated IP pool.
scaling_modestringSpecifies whether the dedicated IP pool is managed or not. The default value is STANDARD.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dedicated_ip_pool resource, the following permissions are required: + +### Read +
+ses:GetDedicatedIpPool,
+ses:GetDedicatedIps
+ +### Update +
+ses:PutDedicatedIpPoolScalingAttributes,
+ses:GetDedicatedIpPool
+ +### Delete +
+ses:DeleteDedicatedIpPool
+ + +## Example +```sql +SELECT +region, +pool_name, +scaling_mode +FROM awscc.ses.dedicated_ip_pool +WHERE region = 'us-east-1' +AND data__Identifier = '<PoolName>' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pools/index.md b/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pools/index.md new file mode 100644 index 0000000000..2b95c3ea55 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pools/index.md @@ -0,0 +1,60 @@ +--- +title: dedicated_ip_pools +hide_title: false +hide_table_of_contents: false +keywords: + - dedicated_ip_pools + - 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 +--- +Retrieves a list of dedicated_ip_pools in a region + +## Overview + + + + + +
Namededicated_ip_pools
TypeResource
Descriptiondedicated_ip_pools
Idawscc.ses.dedicated_ip_pools
+ +## Fields + + + + + +
NameDatatypeDescription
pool_namestringThe name of the dedicated IP pool.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the dedicated_ip_pools resource, the following permissions are required: + +### Create +
+ses:CreateDedicatedIpPool,
+ses:GetDedicatedIpPool,
+ses:GetDedicatedIps
+ +### List +
+ses:ListDedicatedIpPools
+ + +## Example +```sql +SELECT +region, +pool_name +FROM awscc.ses.dedicated_ip_pools +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/email_identities/index.md b/docs/awscc-docs/providers/awscc/ses/email_identities/index.md new file mode 100644 index 0000000000..232f3699bf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/email_identities/index.md @@ -0,0 +1,62 @@ +--- +title: email_identities +hide_title: false +hide_table_of_contents: false +keywords: + - email_identities + - 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 +--- +Retrieves a list of email_identities in a region + +## Overview + + + + + +
Nameemail_identities
TypeResource
Descriptionemail_identities
Idawscc.ses.email_identities
+ +## Fields + + + + + +
NameDatatypeDescription
email_identitystringThe email address or domain to verify.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the email_identities resource, the following permissions are required: + +### Create +
+ses:CreateEmailIdentity,
+ses:PutEmailIdentityMailFromAttributes,
+ses:PutEmailIdentityFeedbackAttributes,
+ses:PutEmailIdentityDkimAttributes,
+ses:GetEmailIdentity
+ +### List +
+ses:ListEmailIdentities
+ + +## Example +```sql +SELECT +region, +email_identity +FROM awscc.ses.email_identities +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/email_identity/index.md b/docs/awscc-docs/providers/awscc/ses/email_identity/index.md new file mode 100644 index 0000000000..05a3ab5477 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/email_identity/index.md @@ -0,0 +1,90 @@ +--- +title: email_identity +hide_title: false +hide_table_of_contents: false +keywords: + - email_identity + - 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 +--- +Gets an individual email_identity resource + +## Overview + + + + + +
Nameemail_identity
TypeResource
Descriptionemail_identity
Idawscc.ses.email_identity
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
email_identitystringThe email address or domain to verify.
configuration_set_attributesobject
dkim_signing_attributesobject
dkim_attributesobject
mail_from_attributesobject
feedback_attributesobject
dkim_dn_stoken_name1string
dkim_dn_stoken_name2string
dkim_dn_stoken_name3string
dkim_dn_stoken_value1string
dkim_dn_stoken_value2string
dkim_dn_stoken_value3string
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the email_identity resource, the following permissions are required: + +### Read +
+ses:GetEmailIdentity
+ +### Update +
+ses:PutEmailIdentityMailFromAttributes,
+ses:PutEmailIdentityFeedbackAttributes,
+ses:PutEmailIdentityConfigurationSetAttributes,
+ses:PutEmailIdentityDkimSigningAttributes,
+ses:PutEmailIdentityDkimAttributes,
+ses:GetEmailIdentity
+ +### Delete +
+ses:DeleteEmailIdentity
+ + +## Example +```sql +SELECT +region, +email_identity, +configuration_set_attributes, +dkim_signing_attributes, +dkim_attributes, +mail_from_attributes, +feedback_attributes, +dkim_dn_stoken_name1, +dkim_dn_stoken_name2, +dkim_dn_stoken_name3, +dkim_dn_stoken_value1, +dkim_dn_stoken_value2, +dkim_dn_stoken_value3 +FROM awscc.ses.email_identity +WHERE region = 'us-east-1' +AND data__Identifier = '<EmailIdentity>' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/index.md b/docs/awscc-docs/providers/awscc/ses/index.md new file mode 100644 index 0000000000..ffbc4e9352 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/index.md @@ -0,0 +1,50 @@ +--- +title: ses +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ses service documentation. + +:::info Service Summary + +
+
+total resources: 13
+total selectable resources: 13
+total methods: 13
+
+
+ +::: + +## Resources +
+
+configuration_set
+configuration_set_event_destination
+configuration_set_event_destinations
+configuration_sets
+contact_list
+contact_lists
+dedicated_ip_pool +
+
+dedicated_ip_pools
+email_identities
+email_identity
+template
+templates
+vdm_attributes +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ses/template/index.md b/docs/awscc-docs/providers/awscc/ses/template/index.md new file mode 100644 index 0000000000..7e96558ebb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/template/index.md @@ -0,0 +1,70 @@ +--- +title: template +hide_title: false +hide_table_of_contents: false +keywords: + - template + - 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 +--- +Gets an individual template resource + +## Overview + + + + + +
Nametemplate
TypeResource
Descriptiontemplate
Idawscc.ses.template
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
templateobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the template resource, the following permissions are required: + +### Read +
+ses:GetEmailTemplate,
+ses:GetTemplate
+ +### Delete +
+ses:DeleteEmailTemplate,
+ses:DeleteTemplate
+ +### Update +
+ses:GetEmailTemplate,
+ses:UpdateEmailTemplate,
+ses:GetTemplate,
+ses:UpdateTemplate
+ + +## Example +```sql +SELECT +region, +id, +template +FROM awscc.ses.template +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/templates/index.md b/docs/awscc-docs/providers/awscc/ses/templates/index.md new file mode 100644 index 0000000000..3f81913d37 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/templates/index.md @@ -0,0 +1,62 @@ +--- +title: templates +hide_title: false +hide_table_of_contents: false +keywords: + - templates + - 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 +--- +Retrieves a list of templates in a region + +## Overview + + + + + +
Nametemplates
TypeResource
Descriptiontemplates
Idawscc.ses.templates
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Create +
+ses:CreateEmailTemplate,
+ses:GetEmailTemplate,
+ses:CreateTemplate,
+ses:GetTemplate
+ +### List +
+ses:ListEmailTemplates,
+ses:ListTemplates
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.ses.templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md b/docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md new file mode 100644 index 0000000000..2aee7a26ae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md @@ -0,0 +1,69 @@ +--- +title: vdm_attributes +hide_title: false +hide_table_of_contents: false +keywords: + - vdm_attributes + - 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 +--- +Gets an individual vdm_attributes resource + +## Overview + + + + + +
Namevdm_attributes
TypeResource
Descriptionvdm_attributes
Idawscc.ses.vdm_attributes
+ +## Fields + + + + + + + +
NameDatatypeDescription
vdm_attributes_resource_idstringUnique identifier for this resource
dashboard_attributesobject
guardian_attributesobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the vdm_attributes resource, the following permissions are required: + +### Read +
+ses:GetAccount
+ +### Update +
+ses:PutAccountVdmAttributes,
+ses:GetAccount
+ +### Delete +
+ses:PutAccountVdmAttributes,
+ses:GetAccount
+ + +## Example +```sql +SELECT +region, +vdm_attributes_resource_id, +dashboard_attributes, +guardian_attributes +FROM awscc.ses.vdm_attributes +WHERE region = 'us-east-1' +AND data__Identifier = '<VdmAttributesResourceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/shield/drt_access/index.md b/docs/awscc-docs/providers/awscc/shield/drt_access/index.md new file mode 100644 index 0000000000..12d901d60f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/drt_access/index.md @@ -0,0 +1,84 @@ +--- +title: drt_access +hide_title: false +hide_table_of_contents: false +keywords: + - drt_access + - 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 +--- +Gets an individual drt_access resource + +## Overview + + + + + +
Namedrt_access
TypeResource
Descriptiondrt_access
Idawscc.shield.drt_access
+ +## Fields + + + + + + + +
NameDatatypeDescription
account_idstring
log_bucket_listarrayAuthorizes 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.
role_arnstringAuthorizes 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the drt_access resource, the following permissions are required: + +### Delete +
+shield:DescribeDRTAccess,
+shield:DisassociateDRTLogBucket,
+shield:DisassociateDRTRole,
+iam:PassRole,
+iam:GetRole,
+iam:ListAttachedRolePolicies,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+s3:DeleteBucketPolicy
+ +### Read +
+shield:DescribeDRTAccess
+ +### Update +
+shield:DescribeDRTAccess,
+shield:AssociateDRTLogBucket,
+shield:AssociateDRTRole,
+shield:DisassociateDRTLogBucket,
+shield:DisassociateDRTRole,
+iam:PassRole,
+iam:GetRole,
+iam:ListAttachedRolePolicies,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+s3:DeleteBucketPolicy
+ + +## Example +```sql +SELECT +region, +account_id, +log_bucket_list, +role_arn +FROM awscc.shield.drt_access +WHERE data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md b/docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md new file mode 100644 index 0000000000..9aa00e1833 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md @@ -0,0 +1,65 @@ +--- +title: drt_accesses +hide_title: false +hide_table_of_contents: false +keywords: + - drt_accesses + - 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 +--- +Retrieves a list of drt_accesses in a region + +## Overview + + + + + +
Namedrt_accesses
TypeResource
Descriptiondrt_accesses
Idawscc.shield.drt_accesses
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the drt_accesses resource, the following permissions are required: + +### Create +
+shield:DescribeDRTAccess,
+shield:AssociateDRTLogBucket,
+shield:AssociateDRTRole,
+iam:PassRole,
+iam:GetRole,
+iam:ListAttachedRolePolicies,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy
+ +### List +
+
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.shield.drt_accesses + +``` diff --git a/docs/awscc-docs/providers/awscc/shield/index.md b/docs/awscc-docs/providers/awscc/shield/index.md new file mode 100644 index 0000000000..287bde833c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/index.md @@ -0,0 +1,45 @@ +--- +title: shield +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The shield service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+drt_access
+drt_accesses
+proactive_engagement
+proactive_engagements +
+
+protection
+protection_group
+protection_groups
+protections +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/shield/proactive_engagement/index.md b/docs/awscc-docs/providers/awscc/shield/proactive_engagement/index.md new file mode 100644 index 0000000000..30afb70613 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/proactive_engagement/index.md @@ -0,0 +1,74 @@ +--- +title: proactive_engagement +hide_title: false +hide_table_of_contents: false +keywords: + - proactive_engagement + - 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 +--- +Gets an individual proactive_engagement resource + +## Overview + + + + + +
Nameproactive_engagement
TypeResource
Descriptionproactive_engagement
Idawscc.shield.proactive_engagement
+ +## Fields + + + + + + + +
NameDatatypeDescription
account_idstring
proactive_engagement_statusstringIf `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.<br/>If `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
emergency_contact_listarrayA 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.<br/>To enable proactive engagement, the contact list must include at least one phone number.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the proactive_engagement resource, the following permissions are required: + +### Delete +
+shield:DescribeSubscription,
+shield:DescribeEmergencyContactSettings,
+shield:UpdateEmergencyContactSettings,
+shield:DisableProactiveEngagement
+ +### Read +
+shield:DescribeSubscription,
+shield:DescribeEmergencyContactSettings
+ +### Update +
+shield:DescribeSubscription,
+shield:DescribeEmergencyContactSettings,
+shield:UpdateEmergencyContactSettings,
+shield:EnableProactiveEngagement,
+shield:DisableProactiveEngagement
+ + +## Example +```sql +SELECT +region, +account_id, +proactive_engagement_status, +emergency_contact_list +FROM awscc.shield.proactive_engagement +WHERE data__Identifier = '<AccountId>' +``` diff --git a/docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md b/docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md new file mode 100644 index 0000000000..1528432ebf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md @@ -0,0 +1,63 @@ +--- +title: proactive_engagements +hide_title: false +hide_table_of_contents: false +keywords: + - proactive_engagements + - 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 +--- +Retrieves a list of proactive_engagements in a region + +## Overview + + + + + +
Nameproactive_engagements
TypeResource
Descriptionproactive_engagements
Idawscc.shield.proactive_engagements
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the proactive_engagements resource, the following permissions are required: + +### Create +
+shield:DescribeSubscription,
+shield:DescribeEmergencyContactSettings,
+shield:AssociateProactiveEngagementDetails,
+shield:UpdateEmergencyContactSettings,
+shield:EnableProactiveEngagement
+ +### List +
+shield:DescribeSubscription,
+shield:DescribeEmergencyContactSettings
+ + +## Example +```sql +SELECT +region, +account_id +FROM awscc.shield.proactive_engagements + +``` diff --git a/docs/awscc-docs/providers/awscc/shield/protection/index.md b/docs/awscc-docs/providers/awscc/shield/protection/index.md new file mode 100644 index 0000000000..ca4f7939ba --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/protection/index.md @@ -0,0 +1,89 @@ +--- +title: protection +hide_title: false +hide_table_of_contents: false +keywords: + - protection + - 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 +--- +Gets an individual protection resource + +## Overview + + + + + +
Nameprotection
TypeResource
Descriptionprotection
Idawscc.shield.protection
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
protection_idstringThe unique identifier (ID) of the protection.
protection_arnstringThe ARN (Amazon Resource Name) of the protection.
namestringFriendly name for the Protection.
resource_arnstringThe ARN (Amazon Resource Name) of the resource to be protected.
health_check_arnsarrayThe Amazon Resource Names (ARNs) of the health check to associate with the protection.
application_layer_automatic_response_configurationobject
tagsarrayOne or more tag key-value pairs for the Protection object.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the protection resource, the following permissions are required: + +### Delete +
+shield:DeleteProtection,
+shield:UntagResource
+ +### Read +
+shield:DescribeProtection,
+shield:ListTagsForResource
+ +### Update +
+shield:DescribeProtection,
+shield:AssociateHealthCheck,
+shield:DisassociateHealthCheck,
+shield:EnableApplicationLayerAutomaticResponse,
+shield:UpdateApplicationLayerAutomaticResponse,
+shield:DisableApplicationLayerAutomaticResponse,
+shield:ListTagsForResource,
+shield:TagResource,
+shield:UntagResource,
+route53:GetHealthCheck,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+wafv2:GetWebACLForResource,
+wafv2:GetWebACL
+ + +## Example +```sql +SELECT +region, +protection_id, +protection_arn, +name, +resource_arn, +health_check_arns, +application_layer_automatic_response_configuration, +tags +FROM awscc.shield.protection +WHERE data__Identifier = '<ProtectionArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/shield/protection_group/index.md b/docs/awscc-docs/providers/awscc/shield/protection_group/index.md new file mode 100644 index 0000000000..bc741d17aa --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/protection_group/index.md @@ -0,0 +1,79 @@ +--- +title: protection_group +hide_title: false +hide_table_of_contents: false +keywords: + - protection_group + - 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 +--- +Gets an individual protection_group resource + +## Overview + + + + + +
Nameprotection_group
TypeResource
Descriptionprotection_group
Idawscc.shield.protection_group
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
protection_group_idstringThe 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.
protection_group_arnstringThe ARN (Amazon Resource Name) of the protection group.
aggregationstringDefines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.<br/>* 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.<br/>* 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.<br/>* 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.
patternstringThe 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.
membersarrayThe 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.
resource_typestringThe 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.
tagsarrayOne or more tag key-value pairs for the Protection object.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the protection_group resource, the following permissions are required: + +### Delete +
+shield:DeleteProtectionGroup,
+shield:UntagResource
+ +### Read +
+shield:DescribeProtectionGroup,
+shield:ListTagsForResource
+ +### Update +
+shield:UpdateProtectionGroup,
+shield:ListTagsForResource,
+shield:TagResource,
+shield:UntagResource
+ + +## Example +```sql +SELECT +region, +protection_group_id, +protection_group_arn, +aggregation, +pattern, +members, +resource_type, +tags +FROM awscc.shield.protection_group +WHERE data__Identifier = '<ProtectionGroupArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/shield/protection_groups/index.md b/docs/awscc-docs/providers/awscc/shield/protection_groups/index.md new file mode 100644 index 0000000000..52eb84a588 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/protection_groups/index.md @@ -0,0 +1,59 @@ +--- +title: protection_groups +hide_title: false +hide_table_of_contents: false +keywords: + - protection_groups + - 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 +--- +Retrieves a list of protection_groups in a region + +## Overview + + + + + +
Nameprotection_groups
TypeResource
Descriptionprotection_groups
Idawscc.shield.protection_groups
+ +## Fields + + + + + +
NameDatatypeDescription
protection_group_arnstringThe ARN (Amazon Resource Name) of the protection group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the protection_groups resource, the following permissions are required: + +### Create +
+shield:CreateProtectionGroup,
+shield:TagResource
+ +### List +
+shield:ListProtectionGroups
+ + +## Example +```sql +SELECT +region, +protection_group_arn +FROM awscc.shield.protection_groups + +``` diff --git a/docs/awscc-docs/providers/awscc/shield/protections/index.md b/docs/awscc-docs/providers/awscc/shield/protections/index.md new file mode 100644 index 0000000000..31d9828da8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/shield/protections/index.md @@ -0,0 +1,71 @@ +--- +title: protections +hide_title: false +hide_table_of_contents: false +keywords: + - protections + - 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 +--- +Retrieves a list of protections in a region + +## Overview + + + + + +
Nameprotections
TypeResource
Descriptionprotections
Idawscc.shield.protections
+ +## Fields + + + + + +
NameDatatypeDescription
protection_arnstringThe ARN (Amazon Resource Name) of the protection.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the protections resource, the following permissions are required: + +### Create +
+shield:CreateProtection,
+shield:DeleteProtection,
+shield:DescribeProtection,
+shield:ListProtections,
+shield:EnableApplicationLayerAutomaticResponse,
+shield:AssociateHealthCheck,
+shield:TagResource,
+ec2:DescribeAddresses,
+elasticloadbalancing:DescribeLoadBalancers,
+route53:GetHealthCheck,
+iam:GetRole,
+iam:CreateServiceLinkedRole,
+wafv2:GetWebACLForResource,
+wafv2:GetWebACL
+ +### List +
+shield:ListProtections
+ + +## Example +```sql +SELECT +region, +protection_arn +FROM awscc.shield.protections + +``` diff --git a/docs/awscc-docs/providers/awscc/signer/index.md b/docs/awscc-docs/providers/awscc/signer/index.md new file mode 100644 index 0000000000..64e177c1dc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/signer/index.md @@ -0,0 +1,41 @@ +--- +title: signer +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The signer service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+profile_permission
+profile_permissions +
+
+signing_profile
+signing_profiles +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/signer/profile_permission/index.md b/docs/awscc-docs/providers/awscc/signer/profile_permission/index.md new file mode 100644 index 0000000000..e9cddb276b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/signer/profile_permission/index.md @@ -0,0 +1,69 @@ +--- +title: profile_permission +hide_title: false +hide_table_of_contents: false +keywords: + - profile_permission + - 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 +--- +Gets an individual profile_permission resource + +## Overview + + + + + +
Nameprofile_permission
TypeResource
Descriptionprofile_permission
Idawscc.signer.profile_permission
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
profile_namestring
profile_versionstring
actionstring
principalstring
statement_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profile_permission resource, the following permissions are required: + +### Read +
+signer:ListProfilePermissions
+ +### Delete +
+signer:RemoveProfilePermission,
+signer:ListProfilePermissions
+ + +## Example +```sql +SELECT +region, +profile_name, +profile_version, +action, +principal, +statement_id +FROM awscc.signer.profile_permission +WHERE region = 'us-east-1' +AND data__Identifier = '<StatementId>' +AND data__Identifier = '<ProfileName>' +``` diff --git a/docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md b/docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md new file mode 100644 index 0000000000..241c4b08da --- /dev/null +++ b/docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md @@ -0,0 +1,62 @@ +--- +title: profile_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - profile_permissions + - 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 +--- +Retrieves a list of profile_permissions in a region + +## Overview + + + + + +
Nameprofile_permissions
TypeResource
Descriptionprofile_permissions
Idawscc.signer.profile_permissions
+ +## Fields + + + + + + +
NameDatatypeDescription
statement_idstring
profile_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profile_permissions resource, the following permissions are required: + +### Create +
+signer:AddProfilePermission,
+signer:ListProfilePermissions
+ +### List +
+signer:ListProfilePermissions,
+signer:GetSigningProfile
+ + +## Example +```sql +SELECT +region, +statement_id, +profile_name +FROM awscc.signer.profile_permissions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/signer/signing_profile/index.md b/docs/awscc-docs/providers/awscc/signer/signing_profile/index.md new file mode 100644 index 0000000000..f0097a27b3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/signer/signing_profile/index.md @@ -0,0 +1,78 @@ +--- +title: signing_profile +hide_title: false +hide_table_of_contents: false +keywords: + - signing_profile + - 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 +--- +Gets an individual signing_profile resource + +## Overview + + + + + +
Namesigning_profile
TypeResource
Descriptionsigning_profile
Idawscc.signer.signing_profile
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
profile_namestringA name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
profile_versionstringA version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
arnstringThe Amazon Resource Name (ARN) of the specified signing profile.
profile_version_arnstringThe Amazon Resource Name (ARN) of the specified signing profile version.
signature_validity_periodobjectSignature validity period of the profile.
platform_idstringThe ID of the target signing platform.
tagsarrayA list of tags associated with the signing profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the signing_profile resource, the following permissions are required: + +### Read +
+signer:GetSigningProfile
+ +### Delete +
+signer:CancelSigningProfile,
+signer:GetSigningProfile
+ +### Update +
+signer:TagResource,
+signer:UntagResource,
+signer:GetSigningProfile
+ + +## Example +```sql +SELECT +region, +profile_name, +profile_version, +arn, +profile_version_arn, +signature_validity_period, +platform_id, +tags +FROM awscc.signer.signing_profile +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md b/docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md new file mode 100644 index 0000000000..eb469e12cb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md @@ -0,0 +1,59 @@ +--- +title: signing_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - signing_profiles + - 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 +--- +Retrieves a list of signing_profiles in a region + +## Overview + + + + + +
Namesigning_profiles
TypeResource
Descriptionsigning_profiles
Idawscc.signer.signing_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedThe Amazon Resource Name (ARN) of the specified signing profile.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the signing_profiles resource, the following permissions are required: + +### Create +
+signer:PutSigningProfile,
+signer:TagResource
+ +### List +
+signer:ListSigningProfiles
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.signer.signing_profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/simspaceweaver/index.md b/docs/awscc-docs/providers/awscc/simspaceweaver/index.md new file mode 100644 index 0000000000..3c382e40a0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/simspaceweaver/index.md @@ -0,0 +1,39 @@ +--- +title: simspaceweaver +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The simspaceweaver service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+simulation +
+
+simulations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/simspaceweaver/simulation/index.md b/docs/awscc-docs/providers/awscc/simspaceweaver/simulation/index.md new file mode 100644 index 0000000000..11029efa72 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/simspaceweaver/simulation/index.md @@ -0,0 +1,78 @@ +--- +title: simulation +hide_title: false +hide_table_of_contents: false +keywords: + - simulation + - 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 +--- +Gets an individual simulation resource + +## Overview + + + + + +
Namesimulation
TypeResource
Descriptionsimulation
Idawscc.simspaceweaver.simulation
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the simulation.
role_arnstringRole ARN.
schema_s3_locationobject
describe_payloadstringJson object with all simulation details
maximum_durationstringThe maximum running time of the simulation.
snapshot_s3_locationobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simulation resource, the following permissions are required: + +### Read +
+simspaceweaver:DescribeSimulation
+ +### Update +
+simspaceweaver:StartSimulation,
+simspaceweaver:StopSimulation,
+simspaceweaver:DeleteSimulation,
+simspaceweaver:DescribeSimulation
+ +### Delete +
+simspaceweaver:StopSimulation,
+simspaceweaver:DeleteSimulation,
+simspaceweaver:DescribeSimulation
+ + +## Example +```sql +SELECT +region, +name, +role_arn, +schema_s3_location, +describe_payload, +maximum_duration, +snapshot_s3_location +FROM awscc.simspaceweaver.simulation +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md b/docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md new file mode 100644 index 0000000000..1762ddd775 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md @@ -0,0 +1,61 @@ +--- +title: simulations +hide_title: false +hide_table_of_contents: false +keywords: + - simulations + - 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 +--- +Retrieves a list of simulations in a region + +## Overview + + + + + +
Namesimulations
TypeResource
Descriptionsimulations
Idawscc.simspaceweaver.simulations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the simulation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the simulations resource, the following permissions are required: + +### Create +
+simspaceweaver:StartSimulation,
+simspaceweaver:DescribeSimulation,
+iam:GetRole,
+iam:PassRole
+ +### List +
+simspaceweaver:ListSimulations
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.simspaceweaver.simulations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sns/index.md b/docs/awscc-docs/providers/awscc/sns/index.md new file mode 100644 index 0000000000..48a941d153 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sns/index.md @@ -0,0 +1,43 @@ +--- +title: sns +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The sns service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+topic
+topic_inline_policies
+topic_inline_policy +
+
+topic_policies
+topic_policy
+topics +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/sns/topic/index.md b/docs/awscc-docs/providers/awscc/sns/topic/index.md new file mode 100644 index 0000000000..fab4615ade --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sns/topic/index.md @@ -0,0 +1,102 @@ +--- +title: topic +hide_title: false +hide_table_of_contents: false +keywords: + - topic + - 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 +--- +Gets an individual topic resource + +## Overview + + + + + +
Nametopic
TypeResource
Descriptiontopic
Idawscc.sns.topic
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
display_namestringThe display name to use for an Amazon SNS topic with SMS subscriptions.
kms_master_key_idstringThe ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.<br/><br/>This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
data_protection_policyobjectThe body of the policy document you want to use for this topic.<br/><br/>You can only add one policy per topic.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 30720
subscriptionarrayThe SNS subscriptions (endpoints) for this topic.
fifo_topicbooleanSet to true to create a FIFO topic.
content_based_deduplicationbooleanEnables 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 action.<br/><br/>When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).<br/><br/>(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.<br/><br/>
archive_policyobjectThe archive policy determines the number of days Amazon SNS retains messages. You can set a retention period from 1 to 365 days.
tagsarray
topic_namestringThe 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.<br/><br/>If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.
topic_arnstring
signature_versionstringVersion of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.
tracing_configstringTracing mode of an Amazon 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. Only supported on standard topics.
delivery_status_loggingarrayDelivery status logging configuration for supported protocols for an Amazon SNS topic.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic resource, the following permissions are required: + +### Read +
+sns:GetTopicAttributes,
+sns:ListTagsForResource,
+sns:ListSubscriptionsByTopic,
+sns:GetDataProtectionPolicy
+ +### Update +
+sns:SetTopicAttributes,
+sns:TagResource,
+sns:UntagResource,
+sns:Subscribe,
+sns:Unsubscribe,
+sns:GetTopicAttributes,
+sns:ListTagsForResource,
+sns:ListSubscriptionsByTopic,
+sns:GetDataProtectionPolicy,
+sns:PutDataProtectionPolicy,
+iam:GetRole,
+iam:PassRole
+ +### Delete +
+sns:GetTopicAttributes,
+sns:DeleteTopic
+ + +## Example +```sql +SELECT +region, +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 awscc.sns.topic +WHERE region = 'us-east-1' +AND data__Identifier = '<TopicArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sns/topic_inline_policies/index.md b/docs/awscc-docs/providers/awscc/sns/topic_inline_policies/index.md new file mode 100644 index 0000000000..03c216b407 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sns/topic_inline_policies/index.md @@ -0,0 +1,55 @@ +--- +title: topic_inline_policies +hide_title: false +hide_table_of_contents: false +keywords: + - topic_inline_policies + - 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 +--- +Retrieves a list of topic_inline_policies in a region + +## Overview + + + + + +
Nametopic_inline_policies
TypeResource
Descriptiontopic_inline_policies
Idawscc.sns.topic_inline_policies
+ +## Fields + + + + + +
NameDatatypeDescription
topic_arnstringThe Amazon Resource Name (ARN) of the topic to which you want to add the policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_inline_policies resource, the following permissions are required: + +### Create +
+sns:SetTopicAttributes,
+sns:GetTopicAttributes
+ + +## Example +```sql +SELECT +region, +topic_arn +FROM awscc.sns.topic_inline_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sns/topic_inline_policy/index.md b/docs/awscc-docs/providers/awscc/sns/topic_inline_policy/index.md new file mode 100644 index 0000000000..4b67382826 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sns/topic_inline_policy/index.md @@ -0,0 +1,67 @@ +--- +title: topic_inline_policy +hide_title: false +hide_table_of_contents: false +keywords: + - topic_inline_policy + - 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 +--- +Gets an individual topic_inline_policy resource + +## Overview + + + + + +
Nametopic_inline_policy
TypeResource
Descriptiontopic_inline_policy
Idawscc.sns.topic_inline_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_documentobjectA policy document that contains permissions to add to the specified SNS topics.
topic_arnstringThe Amazon Resource Name (ARN) of the topic to which you want to add the policy.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_inline_policy resource, the following permissions are required: + +### Read +
+sns:GetTopicAttributes
+ +### Delete +
+sns:SetTopicAttributes,
+sns:GetTopicAttributes
+ +### Update +
+sns:SetTopicAttributes,
+sns:GetTopicAttributes
+ + +## Example +```sql +SELECT +region, +policy_document, +topic_arn +FROM awscc.sns.topic_inline_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<TopicArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sns/topic_policies/index.md b/docs/awscc-docs/providers/awscc/sns/topic_policies/index.md new file mode 100644 index 0000000000..56307c3568 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sns/topic_policies/index.md @@ -0,0 +1,54 @@ +--- +title: topic_policies +hide_title: false +hide_table_of_contents: false +keywords: + - topic_policies + - 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 +--- +Retrieves a list of topic_policies in a region + +## Overview + + + + + +
Nametopic_policies
TypeResource
Descriptiontopic_policies
Idawscc.sns.topic_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe provider-assigned unique ID for this managed resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_policies resource, the following permissions are required: + +### Create +
+sns:SetTopicAttributes
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.sns.topic_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sns/topic_policy/index.md b/docs/awscc-docs/providers/awscc/sns/topic_policy/index.md new file mode 100644 index 0000000000..a61907f217 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sns/topic_policy/index.md @@ -0,0 +1,63 @@ +--- +title: topic_policy +hide_title: false +hide_table_of_contents: false +keywords: + - topic_policy + - 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 +--- +Gets an individual topic_policy resource + +## Overview + + + + + +
Nametopic_policy
TypeResource
Descriptiontopic_policy
Idawscc.sns.topic_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstringThe provider-assigned unique ID for this managed resource.
policy_documentobjectA policy document that contains permissions to add to the specified SNS topics.
topicsarrayThe Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topic_policy resource, the following permissions are required: + +### Update +
+sns:SetTopicAttributes
+ +### Delete +
+sns:SetTopicAttributes
+ + +## Example +```sql +SELECT +region, +id, +policy_document, +topics +FROM awscc.sns.topic_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/sns/topics/index.md b/docs/awscc-docs/providers/awscc/sns/topics/index.md new file mode 100644 index 0000000000..9c450294c5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sns/topics/index.md @@ -0,0 +1,64 @@ +--- +title: topics +hide_title: false +hide_table_of_contents: false +keywords: + - topics + - 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 +--- +Retrieves a list of topics in a region + +## Overview + + + + + +
Nametopics
TypeResource
Descriptiontopics
Idawscc.sns.topics
+ +## Fields + + + + + +
NameDatatypeDescription
topic_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the topics resource, the following permissions are required: + +### Create +
+sns:CreateTopic,
+sns:TagResource,
+sns:Subscribe,
+sns:GetTopicAttributes,
+sns:PutDataProtectionPolicy,
+iam:GetRole,
+iam:PassRole
+ +### List +
+sns:ListTopics
+ + +## Example +```sql +SELECT +region, +topic_arn +FROM awscc.sns.topics +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sqs/index.md b/docs/awscc-docs/providers/awscc/sqs/index.md new file mode 100644 index 0000000000..44eaead87c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sqs/index.md @@ -0,0 +1,43 @@ +--- +title: sqs +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The sqs service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+queue
+queue_inline_policies
+queue_inline_policy +
+
+queue_policies
+queue_policy
+queues +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/sqs/queue/index.md b/docs/awscc-docs/providers/awscc/sqs/queue/index.md new file mode 100644 index 0000000000..309b9c1bf8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sqs/queue/index.md @@ -0,0 +1,103 @@ +--- +title: queue +hide_title: false +hide_table_of_contents: false +keywords: + - queue + - 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 +--- +Gets an individual queue resource + +## Overview + + + + + +
Namequeue
TypeResource
Descriptionqueue
Idawscc.sqs.queue
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
queue_urlstringURL of the source queue.
arnstringAmazon Resource Name (ARN) of the queue.
content_based_deduplicationbooleanFor first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.
deduplication_scopestringSpecifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
delay_secondsintegerThe 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.
fifo_queuebooleanIf set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue.
fifo_throughput_limitstringSpecifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
kms_data_key_reuse_period_secondsintegerThe length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
kms_master_key_idstringThe ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.
sqs_managed_sse_enabledbooleanEnables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).
maximum_message_sizeintegerThe limit of how many bytes that a message can contain before Amazon 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).
message_retention_periodintegerThe number of seconds that Amazon 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).
queue_namestringA name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix.
receive_message_wait_time_secondsintegerSpecifies 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.
redrive_allow_policyobjectThe 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.
redrive_policyobjectA string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.
tagsarrayThe tags that you attach to this queue.
visibility_timeoutintegerThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queue resource, the following permissions are required: + +### Read +
+sqs:GetQueueAttributes,
+sqs:ListQueueTags
+ +### Update +
+sqs:SetQueueAttributes,
+sqs:GetQueueAttributes,
+sqs:ListQueueTags,
+sqs:TagQueue,
+sqs:UntagQueue
+ +### Delete +
+sqs:DeleteQueue,
+sqs:GetQueueAttributes
+ + +## Example +```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, +tags, +visibility_timeout +FROM awscc.sqs.queue +WHERE region = 'us-east-1' +AND data__Identifier = '<QueueUrl>' +``` diff --git a/docs/awscc-docs/providers/awscc/sqs/queue_inline_policies/index.md b/docs/awscc-docs/providers/awscc/sqs/queue_inline_policies/index.md new file mode 100644 index 0000000000..f82c6c6fe0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sqs/queue_inline_policies/index.md @@ -0,0 +1,56 @@ +--- +title: queue_inline_policies +hide_title: false +hide_table_of_contents: false +keywords: + - queue_inline_policies + - 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 +--- +Retrieves a list of queue_inline_policies in a region + +## Overview + + + + + +
Namequeue_inline_policies
TypeResource
Descriptionqueue_inline_policies
Idawscc.sqs.queue_inline_policies
+ +## Fields + + + + + +
NameDatatypeDescription
queuestringThe URL of the SQS queue.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queue_inline_policies resource, the following permissions are required: + +### Create +
+sqs:SetQueueAttributes,
+sqs:GetQueueAttributes,
+sqs:GetQueueUrl
+ + +## Example +```sql +SELECT +region, +queue +FROM awscc.sqs.queue_inline_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sqs/queue_inline_policy/index.md b/docs/awscc-docs/providers/awscc/sqs/queue_inline_policy/index.md new file mode 100644 index 0000000000..4d35f81e43 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sqs/queue_inline_policy/index.md @@ -0,0 +1,69 @@ +--- +title: queue_inline_policy +hide_title: false +hide_table_of_contents: false +keywords: + - queue_inline_policy + - 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 +--- +Gets an individual queue_inline_policy resource + +## Overview + + + + + +
Namequeue_inline_policy
TypeResource
Descriptionqueue_inline_policy
Idawscc.sqs.queue_inline_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_documentobjectA policy document that contains permissions to add to the specified SQS queue
queuestringThe URL of the SQS queue.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queue_inline_policy resource, the following permissions are required: + +### Read +
+sqs:GetQueueAttributes,
+sqs:GetQueueUrl
+ +### Delete +
+sqs:SetQueueAttributes,
+sqs:GetQueueAttributes
+ +### Update +
+sqs:SetQueueAttributes,
+sqs:GetQueueAttributes,
+sqs:GetQueueUrl
+ + +## Example +```sql +SELECT +region, +policy_document, +queue +FROM awscc.sqs.queue_inline_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Queue>' +``` diff --git a/docs/awscc-docs/providers/awscc/sqs/queue_policies/index.md b/docs/awscc-docs/providers/awscc/sqs/queue_policies/index.md new file mode 100644 index 0000000000..449d6bd756 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sqs/queue_policies/index.md @@ -0,0 +1,54 @@ +--- +title: queue_policies +hide_title: false +hide_table_of_contents: false +keywords: + - queue_policies + - 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 +--- +Retrieves a list of queue_policies in a region + +## Overview + + + + + +
Namequeue_policies
TypeResource
Descriptionqueue_policies
Idawscc.sqs.queue_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queue_policies resource, the following permissions are required: + +### Create +
+sqs:SetQueueAttributes
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.sqs.queue_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sqs/queue_policy/index.md b/docs/awscc-docs/providers/awscc/sqs/queue_policy/index.md new file mode 100644 index 0000000000..2a98c6a3e3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sqs/queue_policy/index.md @@ -0,0 +1,63 @@ +--- +title: queue_policy +hide_title: false +hide_table_of_contents: false +keywords: + - queue_policy + - 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 +--- +Gets an individual queue_policy resource + +## Overview + + + + + +
Namequeue_policy
TypeResource
Descriptionqueue_policy
Idawscc.sqs.queue_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
policy_documentobjectA policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.
queuesarrayThe URLs of the queues to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SQS::Queue`` resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queue_policy resource, the following permissions are required: + +### Update +
+sqs:SetQueueAttributes
+ +### Delete +
+sqs:SetQueueAttributes
+ + +## Example +```sql +SELECT +region, +id, +policy_document, +queues +FROM awscc.sqs.queue_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/sqs/queues/index.md b/docs/awscc-docs/providers/awscc/sqs/queues/index.md new file mode 100644 index 0000000000..cf5c03d36e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sqs/queues/index.md @@ -0,0 +1,62 @@ +--- +title: queues +hide_title: false +hide_table_of_contents: false +keywords: + - queues + - 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 +--- +Retrieves a list of queues in a region + +## Overview + + + + + +
Namequeues
TypeResource
Descriptionqueues
Idawscc.sqs.queues
+ +## Fields + + + + + +
NameDatatypeDescription
queue_urlstringURL of the source queue.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the queues resource, the following permissions are required: + +### Create +
+sqs:CreateQueue,
+sqs:GetQueueUrl,
+sqs:GetQueueAttributes,
+sqs:ListQueueTags,
+sqs:TagQueue
+ +### List +
+sqs:ListQueues
+ + +## Example +```sql +SELECT +region, +queue_url +FROM awscc.sqs.queues +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/association/index.md b/docs/awscc-docs/providers/awscc/ssm/association/index.md new file mode 100644 index 0000000000..5f9e2daa3d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/association/index.md @@ -0,0 +1,102 @@ +--- +title: association +hide_title: false +hide_table_of_contents: false +keywords: + - association + - 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 +--- +Gets an individual association resource + +## Overview + + + + + +
Nameassociation
TypeResource
Descriptionassociation
Idawscc.ssm.association
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
association_idstringUnique identifier of the association.
association_namestringThe name of the association.
document_versionstringThe version of the SSM document to associate with the target.
instance_idstringThe ID of the instance that the SSM document is associated with.
namestringThe name of the SSM document.
parametersobjectParameter values that the SSM document uses at runtime.
schedule_expressionstringA Cron or Rate expression that specifies when the association is applied to the target.
targetsarrayThe targets that the SSM document sends commands to.
output_locationobject
automation_target_parameter_namestring
max_errorsstring
max_concurrencystring
compliance_severitystring
sync_compliancestring
wait_for_success_timeout_secondsinteger
apply_only_at_cron_intervalboolean
calendar_namesarray
schedule_offsetinteger
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the association resource, the following permissions are required: + +### Delete +
+ssm:DeleteAssociation
+ +### Update +
+iam:PassRole,
+ssm:UpdateAssociation,
+ssm:GetCalendarState
+ +### Read +
+ssm:DescribeAssociation,
+resource-groups:GetGroupQuery,
+resource-groups:ListGroups,
+resource-groups:ListGroupResources
+ + +## Example +```sql +SELECT +region, +association_id, +association_name, +document_version, +instance_id, +name, +parameters, +schedule_expression, +targets, +output_location, +automation_target_parameter_name, +max_errors, +max_concurrency, +compliance_severity, +sync_compliance, +wait_for_success_timeout_seconds, +apply_only_at_cron_interval, +calendar_names, +schedule_offset +FROM awscc.ssm.association +WHERE region = 'us-east-1' +AND data__Identifier = '<AssociationId>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/associations/index.md b/docs/awscc-docs/providers/awscc/ssm/associations/index.md new file mode 100644 index 0000000000..14ff970639 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/associations/index.md @@ -0,0 +1,63 @@ +--- +title: associations +hide_title: false +hide_table_of_contents: false +keywords: + - associations + - 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 +--- +Retrieves a list of associations in a region + +## Overview + + + + + +
Nameassociations
TypeResource
Descriptionassociations
Idawscc.ssm.associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_idstringUnique identifier of the association.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the associations resource, the following permissions are required: + +### Create +
+ec2:DescribeInstanceStatus,
+iam:PassRole,
+iam:CreateServiceLinkedRole,
+ssm:CreateAssociation,
+ssm:DescribeAssociation,
+ssm:GetCalendarState
+ +### List +
+ssm:ListAssociations
+ + +## Example +```sql +SELECT +region, +association_id +FROM awscc.ssm.associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/document/index.md b/docs/awscc-docs/providers/awscc/ssm/document/index.md new file mode 100644 index 0000000000..bc835b31bb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/document/index.md @@ -0,0 +1,90 @@ +--- +title: document +hide_title: false +hide_table_of_contents: false +keywords: + - document + - 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 +--- +Gets an individual document resource + +## Overview + + + + + +
Namedocument
TypeResource
Descriptiondocument
Idawscc.ssm.document
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
contentobjectThe content for the Systems Manager document in JSON, YAML or String format.
attachmentsarrayA list of key and value pairs that describe attachments to a version of a document.
namestringA name for the Systems Manager document.
version_namestringAn 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.
document_typestringThe type of document to create.
document_formatstringSpecify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
target_typestringSpecify a target type to define the kinds of resources the document can run on.
tagsarrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
requiresarrayA list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
update_methodstringUpdate method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the document resource, the following permissions are required: + +### Read +
+ssm:GetDocument,
+ssm:ListTagsForResource
+ +### Update +
+ssm:UpdateDocument,
+s3:GetObject,
+ssm:AddTagsToResource,
+ssm:RemoveTagsFromResource,
+ssm:ListTagsForResource,
+iam:PassRole,
+ssm:UpdateDocumentDefaultVersion,
+ssm:DescribeDocument
+ +### Delete +
+ssm:DeleteDocument,
+ssm:GetDocument
+ + +## Example +```sql +SELECT +region, +content, +attachments, +name, +version_name, +document_type, +document_format, +target_type, +tags, +requires, +update_method +FROM awscc.ssm.document +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/documents/index.md b/docs/awscc-docs/providers/awscc/ssm/documents/index.md new file mode 100644 index 0000000000..86fb3a3781 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/documents/index.md @@ -0,0 +1,63 @@ +--- +title: documents +hide_title: false +hide_table_of_contents: false +keywords: + - documents + - 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 +--- +Retrieves a list of documents in a region + +## Overview + + + + + +
Namedocuments
TypeResource
Descriptiondocuments
Idawscc.ssm.documents
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA name for the Systems Manager document.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the documents resource, the following permissions are required: + +### Create +
+ssm:CreateDocument,
+ssm:GetDocument,
+ssm:AddTagsToResource,
+ssm:ListTagsForResource,
+s3:GetObject,
+iam:PassRole
+ +### List +
+ssm:ListDocuments
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.ssm.documents +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/index.md b/docs/awscc-docs/providers/awscc/ssm/index.md new file mode 100644 index 0000000000..5e36fadec3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/index.md @@ -0,0 +1,49 @@ +--- +title: ssm +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ssm service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+association
+associations
+document
+documents
+parameter
+parameters +
+
+patch_baseline
+patch_baselines
+resource_data_sync
+resource_data_syncs
+resource_policies
+resource_policy +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ssm/parameter/index.md b/docs/awscc-docs/providers/awscc/ssm/parameter/index.md new file mode 100644 index 0000000000..ea062705db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/parameter/index.md @@ -0,0 +1,82 @@ +--- +title: parameter +hide_title: false +hide_table_of_contents: false +keywords: + - parameter + - 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 +--- +Gets an individual parameter resource + +## Overview + + + + + +
Nameparameter
TypeResource
Descriptionparameter
Idawscc.ssm.parameter
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
typestringThe type of parameter.<br/> Although ``SecureString`` is included in the list of valid values, CFNlong does *not* currently support creating a ``SecureString`` parameter type.
valuestringThe parameter value.<br/> If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field.
descriptionstringInformation about the parameter.
policiesstringInformation about the policies assigned to a parameter.<br/> [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.
allowed_patternstringA 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+$``
tierstringThe parameter tier.
tagsobjectOptional 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.
data_typestringThe data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``.
namestringThe name of the parameter.<br/> 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 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``
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the parameter resource, the following permissions are required: + +### Read +
+ssm:GetParameters
+ +### Update +
+ssm:PutParameter,
+ssm:AddTagsToResource,
+ssm:RemoveTagsFromResource,
+ssm:GetParameters
+ +### Delete +
+ssm:DeleteParameter
+ + +## Example +```sql +SELECT +region, +type, +value, +description, +policies, +allowed_pattern, +tier, +tags, +data_type, +name +FROM awscc.ssm.parameter +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/parameters/index.md b/docs/awscc-docs/providers/awscc/ssm/parameters/index.md new file mode 100644 index 0000000000..1e696e07b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/parameters/index.md @@ -0,0 +1,60 @@ +--- +title: parameters +hide_title: false +hide_table_of_contents: false +keywords: + - parameters + - 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 +--- +Retrieves a list of parameters in a region + +## Overview + + + + + +
Nameparameters
TypeResource
Descriptionparameters
Idawscc.ssm.parameters
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the parameter.<br/> 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 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``
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the parameters resource, the following permissions are required: + +### Create +
+ssm:PutParameter,
+ssm:AddTagsToResource,
+ssm:GetParameters
+ +### List +
+ssm:DescribeParameters
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.ssm.parameters +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md b/docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md new file mode 100644 index 0000000000..48a84f4dfb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md @@ -0,0 +1,101 @@ +--- +title: patch_baseline +hide_title: false +hide_table_of_contents: false +keywords: + - patch_baseline + - 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 +--- +Gets an individual patch_baseline resource + +## Overview + + + + + +
Namepatch_baseline
TypeResource
Descriptionpatch_baseline
Idawscc.ssm.patch_baseline
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringThe ID of the patch baseline.
default_baselinebooleanSet the baseline as default baseline. Only registering to default patch baseline is allowed.
operating_systemstringDefines the operating system the patch baseline applies to. The Default value is WINDOWS.
descriptionstringThe description of the patch baseline.
approval_rulesobject
sourcesarrayInformation about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.
namestringThe name of the patch baseline.
rejected_patchesarrayA list of explicitly rejected patches for the baseline.
approved_patchesarrayA list of explicitly approved patches for the baseline.
rejected_patches_actionstringThe action for Patch Manager to take on patches included in the RejectedPackages list.
patch_groupsarrayPatchGroups is used to associate instances with a specific patch baseline
approved_patches_compliance_levelstringDefines 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.
approved_patches_enable_non_securitybooleanIndicates 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.
global_filtersobjectA set of global filters used to include patches in the baseline.
tagsarrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the patch_baseline resource, the following permissions are required: + +### Delete +
+ssm:DeletePatchBaseline,
+ssm:GetPatchBaseline,
+ssm:DeregisterPatchBaselineForPatchGroup
+ +### Read +
+ssm:GetDefaultPatchBaseline,
+ssm:GetPatchBaseline,
+ssm:ListTagsForResource
+ +### Update +
+ssm:UpdatePatchBaseline,
+ssm:DeregisterPatchBaselineForPatchGroup,
+ssm:AddTagsToResource,
+ssm:RemoveTagsFromResource,
+ssm:ListTagsForResource,
+ssm:GetDefaultPatchBaseline,
+ssm:RegisterDefaultPatchBaseline
+ + +## Example +```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, +tags +FROM awscc.ssm.patch_baseline +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md b/docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md new file mode 100644 index 0000000000..c741883c22 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md @@ -0,0 +1,67 @@ +--- +title: patch_baselines +hide_title: false +hide_table_of_contents: false +keywords: + - patch_baselines + - 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 +--- +Retrieves a list of patch_baselines in a region + +## Overview + + + + + +
Namepatch_baselines
TypeResource
Descriptionpatch_baselines
Idawscc.ssm.patch_baselines
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the patch baseline.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the patch_baselines resource, the following permissions are required: + +### Create +
+ssm:CreatePatchBaseline,
+ssm:RegisterPatchBaselineForPatchGroup,
+ssm:AddTagsToResource,
+ssm:RemoveTagsFromResource,
+ssm:ListTagsForResource,
+ssm:GetDefaultPatchBaseline,
+ssm:RegisterDefaultPatchBaseline
+ +### List +
+ssm:DescribePatchBaselines,
+ssm:GetDefaultPatchBaseline,
+ssm:GetPatchBaseline,
+ssm:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.ssm.patch_baselines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/resource_data_sync/index.md b/docs/awscc-docs/providers/awscc/ssm/resource_data_sync/index.md new file mode 100644 index 0000000000..fe593a7ff5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/resource_data_sync/index.md @@ -0,0 +1,81 @@ +--- +title: resource_data_sync +hide_title: false +hide_table_of_contents: false +keywords: + - resource_data_sync + - 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 +--- +Gets an individual resource_data_sync resource + +## Overview + + + + + +
Nameresource_data_sync
TypeResource
Descriptionresource_data_sync
Idawscc.ssm.resource_data_sync
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
s3_destinationobject
k_ms_key_arnstring
sync_sourceobject
bucket_namestring
bucket_regionstring
sync_formatstring
sync_namestring
sync_typestring
bucket_prefixstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_data_sync resource, the following permissions are required: + +### Delete +
+ssm:ListResourceDataSync,
+ssm:DeleteResourceDataSync
+ +### Update +
+ssm:ListResourceDataSync,
+ssm:UpdateResourceDataSync
+ +### Read +
+ssm:ListResourceDataSync
+ + +## Example +```sql +SELECT +region, +s3_destination, +k_ms_key_arn, +sync_source, +bucket_name, +bucket_region, +sync_format, +sync_name, +sync_type, +bucket_prefix +FROM awscc.ssm.resource_data_sync +WHERE region = 'us-east-1' +AND data__Identifier = '<SyncName>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/resource_data_syncs/index.md b/docs/awscc-docs/providers/awscc/ssm/resource_data_syncs/index.md new file mode 100644 index 0000000000..9e962b023d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/resource_data_syncs/index.md @@ -0,0 +1,59 @@ +--- +title: resource_data_syncs +hide_title: false +hide_table_of_contents: false +keywords: + - resource_data_syncs + - 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 +--- +Retrieves a list of resource_data_syncs in a region + +## Overview + + + + + +
Nameresource_data_syncs
TypeResource
Descriptionresource_data_syncs
Idawscc.ssm.resource_data_syncs
+ +## Fields + + + + + +
NameDatatypeDescription
sync_namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_data_syncs resource, the following permissions are required: + +### Create +
+ssm:CreateResourceDataSync,
+ssm:ListResourceDataSync
+ +### List +
+ssm:ListResourceDataSync
+ + +## Example +```sql +SELECT +region, +sync_name +FROM awscc.ssm.resource_data_syncs +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md b/docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md new file mode 100644 index 0000000000..8bdaff0bbd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md @@ -0,0 +1,60 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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 +--- +Retrieves a list of resource_policies in a region + +## Overview + + + + + +
Nameresource_policies
TypeResource
Descriptionresource_policies
Idawscc.ssm.resource_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_idstringAn unique identifier within the policies of a resource.
resource_arnstringArn of OpsItemGroup etc.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +
+ssm:PutResourcePolicy
+ +### List +
+ssm:GetResourcePolicies
+ + +## Example +```sql +SELECT +region, +policy_id, +resource_arn +FROM awscc.ssm.resource_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md b/docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md new file mode 100644 index 0000000000..c0a255fba5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md @@ -0,0 +1,70 @@ +--- +title: resource_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy + - 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 +--- +Gets an individual resource_policy resource + +## Overview + + + + + +
Nameresource_policy
TypeResource
Descriptionresource_policy
Idawscc.ssm.resource_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
resource_arnstringArn of OpsItemGroup etc.
policyobjectActual policy statement.
policy_idstringAn unique identifier within the policies of a resource.
policy_hashstringA snapshot identifier for the policy over time.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +
+ssm:GetResourcePolicies
+ +### Update +
+ssm:PutResourcePolicy
+ +### Delete +
+ssm:DeleteResourcePolicy
+ + +## Example +```sql +SELECT +region, +resource_arn, +policy, +policy_id, +policy_hash +FROM awscc.ssm.resource_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<PolicyId>' +AND data__Identifier = '<ResourceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md new file mode 100644 index 0000000000..bb787bbf60 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md @@ -0,0 +1,75 @@ +--- +title: contact +hide_title: false +hide_table_of_contents: false +keywords: + - contact + - 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 +--- +Gets an individual contact resource + +## Overview + + + + + +
Namecontact
TypeResource
Descriptioncontact
Idawscc.ssmcontacts.contact
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
aliasstringAlias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
display_namestringName of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
typestringContact type, which specify type of contact. Currently supported values: “PERSONAL”, “SHARED”, “OTHER“.
planarrayThe stages that an escalation plan or engagement plan engages contacts and contact methods in.
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact resource, the following permissions are required: + +### Read +
+ssm-contacts:GetContact
+ +### Update +
+ssm-contacts:UpdateContact,
+ssm-contacts:GetContact,
+ssm-contacts:AssociateContact
+ +### Delete +
+ssm-contacts:DeleteContact,
+ssm-contacts:GetContact,
+ssm-contacts:AssociateContact
+ + +## Example +```sql +SELECT +region, +alias, +display_name, +type, +plan, +arn +FROM awscc.ssmcontacts.contact +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md new file mode 100644 index 0000000000..48c5fa7e10 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md @@ -0,0 +1,75 @@ +--- +title: contact_channel +hide_title: false +hide_table_of_contents: false +keywords: + - contact_channel + - 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 +--- +Gets an individual contact_channel resource + +## Overview + + + + + +
Namecontact_channel
TypeResource
Descriptioncontact_channel
Idawscc.ssmcontacts.contact_channel
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
contact_idstringARN of the contact resource
channel_namestringThe device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
channel_typestringDevice type, which specify notification channel. Currently supported values: “SMS”, “VOICE”, “EMAIL”, “CHATBOT.
defer_activationbooleanIf 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.
channel_addressstringThe details that SSM Incident Manager uses when trying to engage the contact channel.
arnstringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_channel resource, the following permissions are required: + +### Read +
+ssm-contacts:GetContactChannel
+ +### Update +
+ssm-contacts:UpdateContactChannel,
+ssm-contacts:GetContactChannel
+ +### Delete +
+ssm-contacts:DeleteContactChannel,
+ssm-contacts:GetContactChannel
+ + +## Example +```sql +SELECT +region, +contact_id, +channel_name, +channel_type, +defer_activation, +channel_address, +arn +FROM awscc.ssmcontacts.contact_channel +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md new file mode 100644 index 0000000000..753a773f17 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md @@ -0,0 +1,59 @@ +--- +title: contact_channels +hide_title: false +hide_table_of_contents: false +keywords: + - contact_channels + - 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 +--- +Retrieves a list of contact_channels in a region + +## Overview + + + + + +
Namecontact_channels
TypeResource
Descriptioncontact_channels
Idawscc.ssmcontacts.contact_channels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contact_channels resource, the following permissions are required: + +### Create +
+ssm-contacts:CreateContactChannel,
+ssm-contacts:GetContactChannel
+ +### List +
+ssm-contacts:ListContactChannels
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ssmcontacts.contact_channels +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md new file mode 100644 index 0000000000..be8554645f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md @@ -0,0 +1,60 @@ +--- +title: contacts +hide_title: false +hide_table_of_contents: false +keywords: + - contacts + - 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 +--- +Retrieves a list of contacts in a region + +## Overview + + + + + +
Namecontacts
TypeResource
Descriptioncontacts
Idawscc.ssmcontacts.contacts
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the contacts resource, the following permissions are required: + +### Create +
+ssm-contacts:CreateContact,
+ssm-contacts:GetContact,
+ssm-contacts:AssociateContact
+ +### List +
+ssm-contacts:ListContacts
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ssmcontacts.contacts +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/index.md new file mode 100644 index 0000000000..9eef397501 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/index.md @@ -0,0 +1,45 @@ +--- +title: ssmcontacts +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ssmcontacts service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+contact
+contact_channel
+contact_channels
+contacts +
+
+plan
+plans
+rotation
+rotations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/plan/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/plan/index.md new file mode 100644 index 0000000000..a206bce2b2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/plan/index.md @@ -0,0 +1,73 @@ +--- +title: plan +hide_title: false +hide_table_of_contents: false +keywords: + - plan + - 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 +--- +Gets an individual plan resource + +## Overview + + + + + +
Nameplan
TypeResource
Descriptionplan
Idawscc.ssmcontacts.plan
+ +## Fields + + + + + + + + +
NameDatatypeDescription
contact_idstringContact ID for the AWS SSM Incident Manager Contact to associate the plan.
stagesarrayThe stages that an escalation plan or engagement plan engages contacts and contact methods in.
rotation_idsarrayRotation Ids to associate with Oncall Contact for engagement.
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the plan resource, the following permissions are required: + +### Read +
+ssm-contacts:GetContact
+ +### Update +
+ssm-contacts:UpdateContact,
+ssm-contacts:GetContact,
+ssm-contacts:AssociateContact
+ +### Delete +
+ssm-contacts:UpdateContact,
+ssm-contacts:GetContact,
+ssm-contacts:AssociateContact
+ + +## Example +```sql +SELECT +region, +contact_id, +stages, +rotation_ids, +arn +FROM awscc.ssmcontacts.plan +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/plans/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/plans/index.md new file mode 100644 index 0000000000..260e8aec4f --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/plans/index.md @@ -0,0 +1,56 @@ +--- +title: plans +hide_title: false +hide_table_of_contents: false +keywords: + - plans + - 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 +--- +Retrieves a list of plans in a region + +## Overview + + + + + +
Nameplans
TypeResource
Descriptionplans
Idawscc.ssmcontacts.plans
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the plans resource, the following permissions are required: + +### Create +
+ssm-contacts:UpdateContact,
+ssm-contacts:GetContact,
+ssm-contacts:AssociateContact
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ssmcontacts.plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md new file mode 100644 index 0000000000..81ebad63ad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md @@ -0,0 +1,85 @@ +--- +title: rotation +hide_title: false +hide_table_of_contents: false +keywords: + - rotation + - 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 +--- +Gets an individual rotation resource + +## Overview + + + + + +
Namerotation
TypeResource
Descriptionrotation
Idawscc.ssmcontacts.rotation
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the Rotation
contact_idsarrayMembers of the rotation
start_timestringStart time of the first shift of Oncall Schedule
time_zone_idstringTimeZone Identifier for the Oncall Schedule
recurrenceobject
tagsarray
arnstringThe Amazon Resource Name (ARN) of the rotation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rotation resource, the following permissions are required: + +### Read +
+ssm-contacts:GetRotation,
+ssm-contacts:TagResource,
+ssm-contacts:ListTagsForResource,
+ssm-contacts:UntagResource
+ +### Update +
+ssm-contacts:UpdateRotation,
+ssm-contacts:GetRotation,
+ssm-contacts:TagResource,
+ssm-contacts:ListTagsForResource,
+ssm-contacts:UntagResource
+ +### Delete +
+ssm-contacts:DeleteRotation,
+ssm-contacts:GetRotation,
+ssm-contacts:ListTagsForResource,
+ssm-contacts:UntagResource
+ + +## Example +```sql +SELECT +region, +name, +contact_ids, +start_time, +time_zone_id, +recurrence, +tags, +arn +FROM awscc.ssmcontacts.rotation +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md new file mode 100644 index 0000000000..a38f168aca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md @@ -0,0 +1,64 @@ +--- +title: rotations +hide_title: false +hide_table_of_contents: false +keywords: + - rotations + - 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 +--- +Retrieves a list of rotations in a region + +## Overview + + + + + +
Namerotations
TypeResource
Descriptionrotations
Idawscc.ssmcontacts.rotations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the rotation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rotations resource, the following permissions are required: + +### Create +
+ssm-contacts:CreateRotation,
+ssm-contacts:GetRotation,
+ssm-contacts:TagResource,
+ssm-contacts:ListTagsForResource,
+ssm-contacts:UntagResource
+ +### List +
+ssm-contacts:ListRotations,
+ssm-contacts:GetRotation,
+ssm-contacts:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ssmcontacts.rotations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/index.md new file mode 100644 index 0000000000..64ffeb3607 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmincidents/index.md @@ -0,0 +1,41 @@ +--- +title: ssmincidents +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The ssmincidents service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+replication_set
+replication_sets +
+
+response_plan
+response_plans +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/replication_set/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/replication_set/index.md new file mode 100644 index 0000000000..d4b9429ba6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmincidents/replication_set/index.md @@ -0,0 +1,77 @@ +--- +title: replication_set +hide_title: false +hide_table_of_contents: false +keywords: + - replication_set + - 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 +--- +Gets an individual replication_set resource + +## Overview + + + + + +
Namereplication_set
TypeResource
Descriptionreplication_set
Idawscc.ssmincidents.replication_set
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the ReplicationSet.
regionsarrayThe ReplicationSet configuration.
deletion_protectedboolean
tagsarrayThe tags to apply to the replication set.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replication_set resource, the following permissions are required: + +### Read +
+ssm-incidents:ListReplicationSets,
+ssm-incidents:GetReplicationSet,
+ssm-incidents:ListTagsForResource
+ +### Update +
+ssm-incidents:UpdateReplicationSet,
+ssm-incidents:UpdateDeletionProtection,
+ssm-incidents:GetReplicationSet,
+ssm-incidents:TagResource,
+ssm-incidents:UntagResource,
+ssm-incidents:ListTagsForResource
+ +### Delete +
+ssm-incidents:DeleteReplicationSet,
+ssm-incidents:GetReplicationSet
+ + +## Example +```sql +SELECT +region, +arn, +regions, +deletion_protected, +tags +FROM awscc.ssmincidents.replication_set +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md new file mode 100644 index 0000000000..9c675984fb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md @@ -0,0 +1,64 @@ +--- +title: replication_sets +hide_title: false +hide_table_of_contents: false +keywords: + - replication_sets + - 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 +--- +Retrieves a list of replication_sets in a region + +## Overview + + + + + +
Namereplication_sets
TypeResource
Descriptionreplication_sets
Idawscc.ssmincidents.replication_sets
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedThe ARN of the ReplicationSet.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the replication_sets resource, the following permissions are required: + +### Create +
+ssm-incidents:CreateReplicationSet,
+ssm-incidents:ListReplicationSets,
+ssm-incidents:UpdateDeletionProtection,
+ssm-incidents:GetReplicationSet,
+ssm-incidents:TagResource,
+ssm-incidents:ListTagsForResource,
+iam:CreateServiceLinkedRole
+ +### List +
+ssm-incidents:ListReplicationSets
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ssmincidents.replication_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md new file mode 100644 index 0000000000..c3bb23b405 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md @@ -0,0 +1,89 @@ +--- +title: response_plan +hide_title: false +hide_table_of_contents: false +keywords: + - response_plan + - 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 +--- +Gets an individual response_plan resource + +## Overview + + + + + +
Nameresponse_plan
TypeResource
Descriptionresponse_plan
Idawscc.ssmincidents.response_plan
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the response plan.
namestringThe name of the response plan.
display_namestringThe display name of the response plan.
chat_channelobject
engagementsarrayThe list of engagements to use.
actionsarrayThe list of actions.
integrationsarrayThe list of integrations.
tagsarrayThe tags to apply to the response plan.
incident_templateobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the response_plan resource, the following permissions are required: + +### Read +
+ssm-incidents:GetResponsePlan,
+ssm-incidents:ListTagsForResource
+ +### Update +
+ssm-incidents:UpdateResponsePlan,
+ssm-incidents:GetResponsePlan,
+ssm-incidents:TagResource,
+ssm-incidents:UntagResource,
+ssm-incidents:ListTagsForResource,
+iam:PassRole,
+secretsmanager:GetSecretValue,
+kms:Decrypt,
+kms:GenerateDataKey*
+ +### Delete +
+ssm-incidents:DeleteResponsePlan,
+ssm-incidents:GetResponsePlan
+ + +## Example +```sql +SELECT +region, +arn, +name, +display_name, +chat_channel, +engagements, +actions, +integrations, +tags, +incident_template +FROM awscc.ssmincidents.response_plan +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md new file mode 100644 index 0000000000..905f88e6c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md @@ -0,0 +1,65 @@ +--- +title: response_plans +hide_title: false +hide_table_of_contents: false +keywords: + - response_plans + - 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 +--- +Retrieves a list of response_plans in a region + +## Overview + + + + + +
Nameresponse_plans
TypeResource
Descriptionresponse_plans
Idawscc.ssmincidents.response_plans
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the response plan.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the response_plans resource, the following permissions are required: + +### Create +
+ssm-incidents:CreateResponsePlan,
+ssm-incidents:GetResponsePlan,
+ssm-incidents:TagResource,
+ssm-incidents:ListTagsForResource,
+iam:PassRole,
+secretsmanager:GetSecretValue,
+kms:Decrypt,
+kms:GenerateDataKey*
+ +### List +
+ssm-incidents:ListResponsePlans
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.ssmincidents.response_plans +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sso/assignment/index.md b/docs/awscc-docs/providers/awscc/sso/assignment/index.md new file mode 100644 index 0000000000..984d835f3b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sso/assignment/index.md @@ -0,0 +1,80 @@ +--- +title: assignment +hide_title: false +hide_table_of_contents: false +keywords: + - assignment + - 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 +--- +Gets an individual assignment resource + +## Overview + + + + + +
Nameassignment
TypeResource
Descriptionassignment
Idawscc.sso.assignment
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe sso instance that the permission set is owned.
target_idstringThe account id to be provisioned.
target_typestringThe type of resource to be provsioned to, only aws account now
permission_set_arnstringThe permission set that the assignemt will be assigned
principal_typestringThe assignee's type, user/group
principal_idstringThe assignee's identifier, user id/group id
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assignment resource, the following permissions are required: + +### Read +
+sso:ListAccountAssignments,
+iam:GetSAMLProvider,
+iam:ListRolePolicies
+ +### Delete +
+sso:ListAccountAssignments,
+sso:DeleteAccountAssignment,
+sso:DescribeAccountAssignmentDeletionStatus,
+iam:GetSAMLProvider,
+iam:ListRolePolicies
+ + +## Example +```sql +SELECT +region, +instance_arn, +target_id, +target_type, +permission_set_arn, +principal_type, +principal_id +FROM awscc.sso.assignment +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceArn>' +AND data__Identifier = '<TargetId>' +AND data__Identifier = '<TargetType>' +AND data__Identifier = '<PermissionSetArn>' +AND data__Identifier = '<PrincipalType>' +AND data__Identifier = '<PrincipalId>' +``` diff --git a/docs/awscc-docs/providers/awscc/sso/assignments/index.md b/docs/awscc-docs/providers/awscc/sso/assignments/index.md new file mode 100644 index 0000000000..b293015987 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sso/assignments/index.md @@ -0,0 +1,77 @@ +--- +title: assignments +hide_title: false +hide_table_of_contents: false +keywords: + - assignments + - 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 +--- +Retrieves a list of assignments in a region + +## Overview + + + + + +
Nameassignments
TypeResource
Descriptionassignments
Idawscc.sso.assignments
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
instance_arnstringThe sso instance that the permission set is owned.
target_idstringThe account id to be provisioned.
target_typestringThe type of resource to be provsioned to, only aws account now
permission_set_arnstringThe permission set that the assignemt will be assigned
principal_typestringThe assignee's type, user/group
principal_idstringThe assignee's identifier, user id/group id
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assignments resource, the following permissions are required: + +### Create +
+sso:CreateAccountAssignment,
+sso:DescribeAccountAssignmentCreationStatus,
+sso:ListAccountAssignments,
+iam:GetSAMLProvider,
+iam:CreateSAMLProvider,
+iam:AttachRolePolicy,
+iam:PutRolePolicy,
+iam:CreateRole,
+iam:ListRolePolicies
+ +### List +
+sso:ListAccountAssignments,
+iam:ListRolePolicies
+ + +## Example +```sql +SELECT +region, +instance_arn, +target_id, +target_type, +permission_set_arn, +principal_type, +principal_id +FROM awscc.sso.assignments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sso/index.md b/docs/awscc-docs/providers/awscc/sso/index.md new file mode 100644 index 0000000000..ea607e11b4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sso/index.md @@ -0,0 +1,43 @@ +--- +title: sso +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The sso service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+assignment
+assignments
+instance_access_control_attribute_configuration +
+
+instance_access_control_attribute_configurations
+permission_set
+permission_sets +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configuration/index.md b/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configuration/index.md new file mode 100644 index 0000000000..2fd9b7a5e0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configuration/index.md @@ -0,0 +1,69 @@ +--- +title: instance_access_control_attribute_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - instance_access_control_attribute_configuration + - 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 +--- +Gets an individual instance_access_control_attribute_configuration resource + +## Overview + + + + + +
Nameinstance_access_control_attribute_configuration
TypeResource
Descriptioninstance_access_control_attribute_configuration
Idawscc.sso.instance_access_control_attribute_configuration
+ +## Fields + + + + + + + +
NameDatatypeDescription
instance_arnstringThe ARN of the AWS SSO instance under which the operation will be executed.
instance_access_control_attribute_configurationobjectThe InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead.
access_control_attributesarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_access_control_attribute_configuration resource, the following permissions are required: + +### Read +
+sso:DescribeInstanceAccessControlAttributeConfiguration
+ +### Update +
+sso:UpdateInstanceAccessControlAttributeConfiguration,
+sso:DescribeInstanceAccessControlAttributeConfiguration
+ +### Delete +
+sso:DeleteInstanceAccessControlAttributeConfiguration,
+sso:DescribeInstanceAccessControlAttributeConfiguration
+ + +## Example +```sql +SELECT +region, +instance_arn, +instance_access_control_attribute_configuration, +access_control_attributes +FROM awscc.sso.instance_access_control_attribute_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configurations/index.md b/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configurations/index.md new file mode 100644 index 0000000000..d44bd39125 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configurations/index.md @@ -0,0 +1,60 @@ +--- +title: instance_access_control_attribute_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - instance_access_control_attribute_configurations + - 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 +--- +Retrieves a list of instance_access_control_attribute_configurations in a region + +## Overview + + + + + +
Nameinstance_access_control_attribute_configurations
TypeResource
Descriptioninstance_access_control_attribute_configurations
Idawscc.sso.instance_access_control_attribute_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
instance_arnstringThe ARN of the AWS SSO instance under which the operation will be executed.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the instance_access_control_attribute_configurations resource, the following permissions are required: + +### Create +
+sso:CreateInstanceAccessControlAttributeConfiguration,
+sso:UpdateApplicationProfileForAWSAccountInstance,
+sso:DescribeInstanceAccessControlAttributeConfiguration
+ +### List +
+sso:DescribeInstanceAccessControlAttributeConfiguration
+ + +## Example +```sql +SELECT +region, +instance_arn +FROM awscc.sso.instance_access_control_attribute_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/sso/permission_set/index.md b/docs/awscc-docs/providers/awscc/sso/permission_set/index.md new file mode 100644 index 0000000000..b92f4d2157 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sso/permission_set/index.md @@ -0,0 +1,107 @@ +--- +title: permission_set +hide_title: false +hide_table_of_contents: false +keywords: + - permission_set + - 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 +--- +Gets an individual permission_set resource + +## Overview + + + + + +
Namepermission_set
TypeResource
Descriptionpermission_set
Idawscc.sso.permission_set
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this permission set.
permission_set_arnstringThe permission set that the policy will be attached to
descriptionstringThe permission set description.
instance_arnstringThe sso instance arn that the permission set is owned.
session_durationstringThe length of time that a user can be signed in to an AWS account.
relay_state_typestringThe relay state URL that redirect links to any service in the AWS Management Console.
managed_policiesarray
inline_policyobjectThe inline policy to put in permission set.
tagsarray
customer_managed_policy_referencesarray
permissions_boundaryobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permission_set resource, the following permissions are required: + +### Read +
+sso:DescribePermissionSet,
+sso:ListTagsForResource,
+sso:ListManagedPoliciesInPermissionSet,
+sso:ListCustomerManagedPolicyReferencesInPermissionSet,
+sso:GetInlinePolicyForPermissionSet,
+sso:GetPermissionsBoundaryForPermissionSet
+ +### Update +
+sso:UpdatePermissionSet,
+sso:TagResource,
+sso:UntagResource,
+sso:ListTagsForResource,
+sso:AttachManagedPolicyToPermissionSet,
+sso:AttachCustomerManagedPolicyReferenceToPermissionSet,
+sso:DetachManagedPolicyFromPermissionSet,
+sso:DetachCustomerManagedPolicyReferenceFromPermissionSet,
+sso:ListManagedPoliciesInPermissionSet,
+sso:ListCustomerManagedPolicyReferencesInPermissionSet,
+sso:PutInlinePolicyToPermissionSet,
+sso:GetPermissionsBoundaryForPermissionSet,
+sso:DeletePermissionsBoundaryFromPermissionSet,
+sso:PutPermissionsBoundaryToPermissionSet,
+sso:DeleteInlinePolicyFromPermissionSet,
+sso:ProvisionPermissionSet,
+sso:DescribePermissionSet,
+sso:GetInlinePolicyForPermissionSet,
+sso:DescribePermissionSetProvisioningStatus
+ +### Delete +
+sso:DeletePermissionSet
+ + +## Example +```sql +SELECT +region, +name, +permission_set_arn, +description, +instance_arn, +session_duration, +relay_state_type, +managed_policies, +inline_policy, +tags, +customer_managed_policy_references, +permissions_boundary +FROM awscc.sso.permission_set +WHERE region = 'us-east-1' +AND data__Identifier = '<InstanceArn>' +AND data__Identifier = '<PermissionSetArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/sso/permission_sets/index.md b/docs/awscc-docs/providers/awscc/sso/permission_sets/index.md new file mode 100644 index 0000000000..a6cd8415db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/sso/permission_sets/index.md @@ -0,0 +1,71 @@ +--- +title: permission_sets +hide_title: false +hide_table_of_contents: false +keywords: + - permission_sets + - 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 +--- +Retrieves a list of permission_sets in a region + +## Overview + + + + + +
Namepermission_sets
TypeResource
Descriptionpermission_sets
Idawscc.sso.permission_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
instance_arnstringThe sso instance arn that the permission set is owned.
permission_set_arnstringThe permission set that the policy will be attached to
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the permission_sets resource, the following permissions are required: + +### Create +
+sso:CreatePermissionSet,
+sso:PutInlinePolicyToPermissionSet,
+sso:AttachManagedPolicyToPermissionSet,
+sso:AttachCustomerManagedPolicyReferenceToPermissionSet,
+sso:PutPermissionsBoundaryToPermissionSet,
+sso:TagResource,
+sso:DescribePermissionSet,
+sso:ListTagsForResource,
+sso:ListManagedPoliciesInPermissionSet,
+sso:ListCustomerManagedPolicyReferencesInPermissionSet,
+sso:GetInlinePolicyForPermissionSet,
+sso:GetPermissionsBoundaryForPermissionSet
+ +### List +
+sso:DescribePermissionSet
+ + +## Example +```sql +SELECT +region, +instance_arn, +permission_set_arn +FROM awscc.sso.permission_sets +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/activities/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/activities/index.md new file mode 100644 index 0000000000..f8da0cc696 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/activities/index.md @@ -0,0 +1,54 @@ +--- +title: activities +hide_title: false +hide_table_of_contents: false +keywords: + - activities + - 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 +--- +Retrieves a list of activities in a region + +## Overview + + + + + +
Nameactivities
TypeResource
Descriptionactivities
Idawscc.stepfunctions.activities
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the activities resource, the following permissions are required: + +### Create +
+states:CreateActivity
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.stepfunctions.activities +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md new file mode 100644 index 0000000000..d4a4ee8dd9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md @@ -0,0 +1,70 @@ +--- +title: activity +hide_title: false +hide_table_of_contents: false +keywords: + - activity + - 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 +--- +Gets an individual activity resource + +## Overview + + + + + +
Nameactivity
TypeResource
Descriptionactivity
Idawscc.stepfunctions.activity
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
namestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the activity resource, the following permissions are required: + +### Read +
+states:DescribeActivity,
+states:ListTagsForResource
+ +### Update +
+states:ListTagsForResource,
+states:TagResource,
+states:UntagResource
+ +### Delete +
+states:DeleteActivity
+ + +## Example +```sql +SELECT +region, +arn, +name, +tags +FROM awscc.stepfunctions.activity +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/index.md new file mode 100644 index 0000000000..73e772dae3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/index.md @@ -0,0 +1,45 @@ +--- +title: stepfunctions +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The stepfunctions service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+activities
+activity
+state_machine
+state_machine_alias +
+
+state_machine_aliases
+state_machine_version
+state_machine_versions
+state_machines +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine/index.md new file mode 100644 index 0000000000..be17d31dae --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine/index.md @@ -0,0 +1,93 @@ +--- +title: state_machine +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine + - 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 +--- +Gets an individual state_machine resource + +## Overview + + + + + +
Namestate_machine
TypeResource
Descriptionstate_machine
Idawscc.stepfunctions.state_machine
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
definition_stringstring
role_arnstring
state_machine_namestring
state_machine_typestring
state_machine_revision_idstring
logging_configurationobject
tracing_configurationobject
definition_s3_locationobject
definition_substitutionsobject
definitionobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the state_machine resource, the following permissions are required: + +### Read +
+states:DescribeStateMachine,
+states:ListTagsForResource
+ +### Update +
+states:UpdateStateMachine,
+states:TagResource,
+states:UntagResource,
+states:ListTagsForResource,
+iam:PassRole
+ +### Delete +
+states:DeleteStateMachine,
+states:DescribeStateMachine
+ + +## Example +```sql +SELECT +region, +arn, +name, +definition_string, +role_arn, +state_machine_name, +state_machine_type, +state_machine_revision_id, +logging_configuration, +tracing_configuration, +definition_s3_location, +definition_substitutions, +definition, +tags +FROM awscc.stepfunctions.state_machine +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_alias/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_alias/index.md new file mode 100644 index 0000000000..5cce43a477 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_alias/index.md @@ -0,0 +1,74 @@ +--- +title: state_machine_alias +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_alias + - 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 +--- +Gets an individual state_machine_alias resource + +## Overview + + + + + +
Namestate_machine_alias
TypeResource
Descriptionstate_machine_alias
Idawscc.stepfunctions.state_machine_alias
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstringThe ARN of the alias.
namestringThe alias name.
descriptionstringAn optional description of the alias.
routing_configurationarray
deployment_preferenceobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the state_machine_alias resource, the following permissions are required: + +### Read +
+states:DescribeStateMachineAlias
+ +### Update +
+cloudwatch:DescribeAlarms,
+states:UpdateStateMachineAlias,
+states:DescribeStateMachineAlias
+ +### Delete +
+states:DescribeStateMachineAlias,
+states:DeleteStateMachineAlias
+ + +## Example +```sql +SELECT +region, +arn, +name, +description, +routing_configuration, +deployment_preference +FROM awscc.stepfunctions.state_machine_alias +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_aliases/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_aliases/index.md new file mode 100644 index 0000000000..c1e2d698d3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_aliases/index.md @@ -0,0 +1,59 @@ +--- +title: state_machine_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_aliases + - 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 +--- +Retrieves a list of state_machine_aliases in a region + +## Overview + + + + + +
Namestate_machine_aliases
TypeResource
Descriptionstate_machine_aliases
Idawscc.stepfunctions.state_machine_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the alias.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the state_machine_aliases resource, the following permissions are required: + +### Create +
+states:CreateStateMachineAlias,
+states:DescribeStateMachineAlias
+ +### List +
+states:ListStateMachineAliases
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.stepfunctions.state_machine_aliases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_version/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_version/index.md new file mode 100644 index 0000000000..e3b012205d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_version/index.md @@ -0,0 +1,66 @@ +--- +title: state_machine_version +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_version + - 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 +--- +Gets an individual state_machine_version resource + +## Overview + + + + + +
Namestate_machine_version
TypeResource
Descriptionstate_machine_version
Idawscc.stepfunctions.state_machine_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring
state_machine_arnstring
state_machine_revision_idstring
descriptionstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the state_machine_version resource, the following permissions are required: + +### Read +
+states:DescribeStateMachine
+ +### Delete +
+states:DeleteStateMachineVersion,
+states:DescribeStateMachine
+ + +## Example +```sql +SELECT +region, +arn, +state_machine_arn, +state_machine_revision_id, +description +FROM awscc.stepfunctions.state_machine_version +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_versions/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_versions/index.md new file mode 100644 index 0000000000..95c30406bc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_versions/index.md @@ -0,0 +1,60 @@ +--- +title: state_machine_versions +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_versions + - 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 +--- +Retrieves a list of state_machine_versions in a region + +## Overview + + + + + +
Namestate_machine_versions
TypeResource
Descriptionstate_machine_versions
Idawscc.stepfunctions.state_machine_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the state_machine_versions resource, the following permissions are required: + +### Create +
+states:PublishStateMachineVersion,
+states:ListStateMachineVersions,
+states:DescribeStateMachine
+ +### List +
+states:ListStateMachineVersions
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.stepfunctions.state_machine_versions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md new file mode 100644 index 0000000000..4b177b4c17 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md @@ -0,0 +1,62 @@ +--- +title: state_machines +hide_title: false +hide_table_of_contents: false +keywords: + - state_machines + - 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 +--- +Retrieves a list of state_machines in a region + +## Overview + + + + + +
Namestate_machines
TypeResource
Descriptionstate_machines
Idawscc.stepfunctions.state_machines
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the state_machines resource, the following permissions are required: + +### Create +
+states:CreateStateMachine,
+states:DescribeStateMachine,
+states:TagResource,
+iam:PassRole,
+s3:GetObject
+ +### List +
+states:ListStateMachines
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.stepfunctions.state_machines +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md b/docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md new file mode 100644 index 0000000000..4526f085c2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md @@ -0,0 +1,67 @@ +--- +title: account_alias +hide_title: false +hide_table_of_contents: false +keywords: + - account_alias + - 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 +--- +Gets an individual account_alias resource + +## Overview + + + + + +
Nameaccount_alias
TypeResource
Descriptionaccount_alias
Idawscc.supportapp.account_alias
+ +## Fields + + + + + + +
NameDatatypeDescription
account_aliasstringAn account alias associated with a customer's account.
account_alias_resource_idstringUnique identifier representing an alias tied to an account
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account_alias resource, the following permissions are required: + +### Read +
+supportapp:GetAccountAlias
+ +### Update +
+supportapp:PutAccountAlias,
+supportapp:GetAccountAlias
+ +### Delete +
+supportapp:DeleteAccountAlias,
+supportapp:GetAccountAlias
+ + +## Example +```sql +SELECT +region, +account_alias, +account_alias_resource_id +FROM awscc.supportapp.account_alias +WHERE region = 'us-east-1' +AND data__Identifier = '<AccountAliasResourceId>' +``` diff --git a/docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md b/docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md new file mode 100644 index 0000000000..a9973adfa0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md @@ -0,0 +1,59 @@ +--- +title: account_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - account_aliases + - 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 +--- +Retrieves a list of account_aliases in a region + +## Overview + + + + + +
Nameaccount_aliases
TypeResource
Descriptionaccount_aliases
Idawscc.supportapp.account_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
account_alias_resource_idstringUnique identifier representing an alias tied to an account
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the account_aliases resource, the following permissions are required: + +### Create +
+supportapp:PutAccountAlias,
+supportapp:GetAccountAlias
+ +### List +
+supportapp:GetAccountAlias
+ + +## Example +```sql +SELECT +region, +account_alias_resource_id +FROM awscc.supportapp.account_aliases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/supportapp/index.md b/docs/awscc-docs/providers/awscc/supportapp/index.md new file mode 100644 index 0000000000..7c910e271e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/supportapp/index.md @@ -0,0 +1,43 @@ +--- +title: supportapp +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The supportapp service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+account_alias
+account_aliases
+slack_channel_configuration +
+
+slack_channel_configurations
+slack_workspace_configuration
+slack_workspace_configurations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configuration/index.md b/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configuration/index.md new file mode 100644 index 0000000000..f5f09fc75a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configuration/index.md @@ -0,0 +1,80 @@ +--- +title: slack_channel_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configuration + - 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 +--- +Gets an individual slack_channel_configuration resource + +## Overview + + + + + +
Nameslack_channel_configuration
TypeResource
Descriptionslack_channel_configuration
Idawscc.supportapp.slack_channel_configuration
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
channel_idstringThe channel ID in Slack, which identifies a channel within a workspace.
channel_namestringThe channel name in Slack.
notify_on_create_or_reopen_casebooleanWhether to notify when a case is created or reopened.
notify_on_add_correspondence_to_casebooleanWhether to notify when a correspondence is added to a case.
notify_on_resolve_casebooleanWhether to notify when a case is resolved.
notify_on_case_severitystringThe severity level of a support case that a customer wants to get notified for.
channel_role_arnstringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the slack_channel_configuration resource, the following permissions are required: + +### Read +
+supportapp:ListSlackChannelConfigurations
+ +### Update +
+supportapp:UpdateSlackChannelConfiguration,
+supportapp:ListSlackChannelConfigurations
+ +### Delete +
+supportapp:DeleteSlackChannelConfiguration,
+supportapp:ListSlackChannelConfigurations
+ + +## Example +```sql +SELECT +region, +team_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 awscc.supportapp.slack_channel_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<TeamId>' +AND data__Identifier = '<ChannelId>' +``` diff --git a/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configurations/index.md b/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configurations/index.md new file mode 100644 index 0000000000..e4c33356b5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configurations/index.md @@ -0,0 +1,61 @@ +--- +title: slack_channel_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configurations + - 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 +--- +Retrieves a list of slack_channel_configurations in a region + +## Overview + + + + + +
Nameslack_channel_configurations
TypeResource
Descriptionslack_channel_configurations
Idawscc.supportapp.slack_channel_configurations
+ +## Fields + + + + + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
channel_idstringThe channel ID in Slack, which identifies a channel within a workspace.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the slack_channel_configurations resource, the following permissions are required: + +### Create +
+supportapp:CreateSlackChannelConfiguration,
+supportapp:ListSlackChannelConfigurations
+ +### List +
+supportapp:ListSlackChannelConfigurations
+ + +## Example +```sql +SELECT +region, +team_id, +channel_id +FROM awscc.supportapp.slack_channel_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configuration/index.md b/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configuration/index.md new file mode 100644 index 0000000000..0b01900666 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configuration/index.md @@ -0,0 +1,67 @@ +--- +title: slack_workspace_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - slack_workspace_configuration + - 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 +--- +Gets an individual slack_workspace_configuration resource + +## Overview + + + + + +
Nameslack_workspace_configuration
TypeResource
Descriptionslack_workspace_configuration
Idawscc.supportapp.slack_workspace_configuration
+ +## Fields + + + + + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
version_idstringAn identifier used to update an existing Slack workspace configuration in AWS CloudFormation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the slack_workspace_configuration resource, the following permissions are required: + +### Read +
+supportapp:ListSlackWorkspaceConfigurations
+ +### Update +
+supportapp:RegisterSlackWorkspaceForOrganization,
+supportapp:ListSlackWorkspaceConfigurations
+ +### Delete +
+supportapp:ListSlackWorkspaceConfigurations,
+supportapp:DeleteSlackWorkspaceConfiguration
+ + +## Example +```sql +SELECT +region, +team_id, +version_id +FROM awscc.supportapp.slack_workspace_configuration +WHERE region = 'us-east-1' +AND data__Identifier = '<TeamId>' +``` diff --git a/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configurations/index.md b/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configurations/index.md new file mode 100644 index 0000000000..af92aad396 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configurations/index.md @@ -0,0 +1,59 @@ +--- +title: slack_workspace_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - slack_workspace_configurations + - 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 +--- +Retrieves a list of slack_workspace_configurations in a region + +## Overview + + + + + +
Nameslack_workspace_configurations
TypeResource
Descriptionslack_workspace_configurations
Idawscc.supportapp.slack_workspace_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the slack_workspace_configurations resource, the following permissions are required: + +### Create +
+supportapp:RegisterSlackWorkspaceForOrganization,
+supportapp:ListSlackWorkspaceConfigurations
+ +### List +
+supportapp:ListSlackWorkspaceConfigurations
+ + +## Example +```sql +SELECT +region, +team_id +FROM awscc.supportapp.slack_workspace_configurations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/synthetics/canaries/index.md b/docs/awscc-docs/providers/awscc/synthetics/canaries/index.md new file mode 100644 index 0000000000..69425de6c0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/synthetics/canaries/index.md @@ -0,0 +1,79 @@ +--- +title: canaries +hide_title: false +hide_table_of_contents: false +keywords: + - canaries + - 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 +--- +Retrieves a list of canaries in a region + +## Overview + + + + + +
Namecanaries
TypeResource
Descriptioncanaries
Idawscc.synthetics.canaries
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the canary.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the canaries resource, the following permissions are required: + +### Create +
+synthetics:CreateCanary,
+synthetics:StartCanary,
+synthetics:GetCanary,
+synthetics:TagResource,
+s3:CreateBucket,
+s3:GetObject,
+s3:GetObjectVersion,
+s3:PutBucketEncryption,
+s3:PutEncryptionConfiguration,
+s3:GetBucketLocation,
+lambda:CreateFunction,
+lambda:AddPermission,
+lambda:PublishVersion,
+lambda:UpdateFunctionConfiguration,
+lambda:GetFunctionConfiguration,
+lambda:GetLayerVersionByArn,
+lambda:GetLayerVersion,
+lambda:PublishLayerVersion,
+ec2:DescribeVpcs,
+ec2:DescribeSubnets,
+ec2:DescribeSecurityGroups,
+iam:PassRole
+ +### List +
+synthetics:DescribeCanaries
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.synthetics.canaries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/synthetics/canary/index.md b/docs/awscc-docs/providers/awscc/synthetics/canary/index.md new file mode 100644 index 0000000000..0e7f421944 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/synthetics/canary/index.md @@ -0,0 +1,119 @@ +--- +title: canary +hide_title: false +hide_table_of_contents: false +keywords: + - canary + - 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 +--- +Gets an individual canary resource + +## Overview + + + + + +
Namecanary
TypeResource
Descriptioncanary
Idawscc.synthetics.canary
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of the canary.
idstringId of the canary
statestringState of the canary
codeobjectProvide the canary script source
artifact_s3_locationstringProvide the s3 bucket output location for test results
artifact_configobjectProvide artifact configuration
scheduleobjectFrequency to run your canaries
execution_role_arnstringLambda Execution role used to run your canaries
runtime_versionstringRuntime version of Synthetics Library
success_retention_periodintegerRetention period of successful canary runs represented in number of days
failure_retention_periodintegerRetention period of failed canary runs represented in number of days
tagsarray
v_pc_configobjectProvide VPC Configuration if enabled.
run_configobjectProvide canary run configuration
start_canary_after_creationbooleanRuns canary if set to True. Default is False
visual_referenceobjectVisual reference configuration for visual testing
delete_lambda_resources_on_canary_deletionbooleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the canary resource, the following permissions are required: + +### Update +
+synthetics:UpdateCanary,
+synthetics:StartCanary,
+synthetics:StopCanary,
+synthetics:GetCanary,
+synthetics:TagResource,
+synthetics:UntagResource,
+s3:GetObject,
+s3:GetObjectVersion,
+s3:PutBucketEncryption,
+s3:PutEncryptionConfiguration,
+s3:GetBucketLocation,
+lambda:AddPermission,
+lambda:PublishVersion,
+lambda:UpdateFunctionConfiguration,
+lambda:GetFunctionConfiguration,
+lambda:GetLayerVersionByArn,
+lambda:GetLayerVersion,
+lambda:PublishLayerVersion,
+iam:PassRole
+ +### Read +
+synthetics:GetCanary,
+synthetics:DescribeCanaries,
+synthetics:ListTagsForResource,
+iam:ListRoles,
+s3:ListAllMyBuckets,
+s3:GetBucketLocation
+ +### Delete +
+synthetics:DeleteCanary,
+synthetics:GetCanary
+ + +## Example +```sql +SELECT +region, +name, +id, +state, +code, +artifact_s3_location, +artifact_config, +schedule, +execution_role_arn, +runtime_version, +success_retention_period, +failure_retention_period, +tags, +v_pc_config, +run_config, +start_canary_after_creation, +visual_reference, +delete_lambda_resources_on_canary_deletion +FROM awscc.synthetics.canary +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/synthetics/group/index.md b/docs/awscc-docs/providers/awscc/synthetics/group/index.md new file mode 100644 index 0000000000..6be025724a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/synthetics/group/index.md @@ -0,0 +1,77 @@ +--- +title: group +hide_title: false +hide_table_of_contents: false +keywords: + - group + - 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 +--- +Gets an individual group resource + +## Overview + + + + + +
Namegroup
TypeResource
Descriptiongroup
Idawscc.synthetics.group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringName of the group.
idstringId of the group.
tagsarray
resource_arnsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Update +
+synthetics:AssociateResource,
+synthetics:DisassociateResource,
+synthetics:TagResource,
+synthetics:UntagResource,
+synthetics:GetGroup,
+synthetics:ListGroupResources
+ +### Read +
+synthetics:GetGroup,
+synthetics:ListTagsForResource,
+synthetics:ListGroupResources
+ +### Delete +
+synthetics:DeleteGroup,
+synthetics:GetGroup
+ + +## Example +```sql +SELECT +region, +name, +id, +tags, +resource_arns +FROM awscc.synthetics.group +WHERE region = 'us-east-1' +AND data__Identifier = '<Name>' +``` diff --git a/docs/awscc-docs/providers/awscc/synthetics/groups/index.md b/docs/awscc-docs/providers/awscc/synthetics/groups/index.md new file mode 100644 index 0000000000..81e2b299c1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/synthetics/groups/index.md @@ -0,0 +1,61 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - groups + - 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 +--- +Retrieves a list of groups in a region + +## Overview + + + + + +
Namegroups
TypeResource
Descriptiongroups
Idawscc.synthetics.groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the group.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +
+synthetics:CreateGroup,
+synthetics:AssociateResource,
+synthetics:TagResource,
+synthetics:GetGroup
+ +### List +
+synthetics:ListGroups
+ + +## Example +```sql +SELECT +region, +name +FROM awscc.synthetics.groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/synthetics/index.md b/docs/awscc-docs/providers/awscc/synthetics/index.md new file mode 100644 index 0000000000..007fb99b46 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/synthetics/index.md @@ -0,0 +1,41 @@ +--- +title: synthetics +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The synthetics service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+canaries
+canary +
+
+group
+groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/systemsmanagersap/application/index.md b/docs/awscc-docs/providers/awscc/systemsmanagersap/application/index.md new file mode 100644 index 0000000000..125ca74b45 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/systemsmanagersap/application/index.md @@ -0,0 +1,82 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 +--- +Gets an individual application resource + +## Overview + + + + + +
Nameapplication
TypeResource
Descriptionapplication
Idawscc.systemsmanagersap.application
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
application_idstring
application_typestring
arnstringThe ARN of the Helix application
credentialsarray
instancesarray
sap_instance_numberstring
sidstring
tagsarrayThe tags of a SystemsManagerSAP application.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +
+ssm-sap:GetApplication,
+ssm-sap:ListTagsForResource
+ +### Update +
+ssm-sap:TagResource,
+ssm-sap:UntagResource,
+ssm-sap:ListTagsForResource,
+ssm-sap:GetApplication
+ +### Delete +
+ssm-sap:DeregisterApplication,
+ssm-sap:GetApplication
+ + +## Example +```sql +SELECT +region, +application_id, +application_type, +arn, +credentials, +instances, +sap_instance_number, +sid, +tags +FROM awscc.systemsmanagersap.application +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md b/docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md new file mode 100644 index 0000000000..a47e205977 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md @@ -0,0 +1,61 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 +--- +Retrieves a list of applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
Descriptionapplications
Idawscc.systemsmanagersap.applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the Helix application
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +
+ssm-sap:RegisterApplication,
+ssm-sap:GetApplication,
+ssm-sap:TagResource,
+ssm-sap:ListTagsForResource
+ +### List +
+ssm-sap:ListApplications
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.systemsmanagersap.applications +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/systemsmanagersap/index.md b/docs/awscc-docs/providers/awscc/systemsmanagersap/index.md new file mode 100644 index 0000000000..ce77ad5dcd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/systemsmanagersap/index.md @@ -0,0 +1,39 @@ +--- +title: systemsmanagersap +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The systemsmanagersap service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+application +
+
+applications +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/timestream/database/index.md b/docs/awscc-docs/providers/awscc/timestream/database/index.md new file mode 100644 index 0000000000..dda0cbb2ad --- /dev/null +++ b/docs/awscc-docs/providers/awscc/timestream/database/index.md @@ -0,0 +1,76 @@ +--- +title: database +hide_title: false +hide_table_of_contents: false +keywords: + - database + - 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 +--- +Gets an individual database resource + +## Overview + + + + + +
Namedatabase
TypeResource
Descriptiondatabase
Idawscc.timestream.database
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring
database_namestringThe 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.
kms_key_idstringThe 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.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the database resource, the following permissions are required: + +### Read +
+timestream:DescribeDatabase,
+timestream:DescribeEndpoints,
+timestream:ListTagsForResource
+ +### Update +
+timestream:UpdateDatabase,
+timestream:DescribeDatabase,
+timestream:DescribeEndpoints,
+timestream:TagResource,
+timestream:UntagResource
+ +### Delete +
+timestream:DeleteDatabase,
+timestream:DescribeEndpoints
+ + +## Example +```sql +SELECT +region, +arn, +database_name, +kms_key_id, +tags +FROM awscc.timestream.database +WHERE region = 'us-east-1' +AND data__Identifier = '<DatabaseName>' +``` diff --git a/docs/awscc-docs/providers/awscc/timestream/databases/index.md b/docs/awscc-docs/providers/awscc/timestream/databases/index.md new file mode 100644 index 0000000000..a8113acdf6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/timestream/databases/index.md @@ -0,0 +1,64 @@ +--- +title: databases +hide_title: false +hide_table_of_contents: false +keywords: + - databases + - 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 +--- +Retrieves a list of databases in a region + +## Overview + + + + + +
Namedatabases
TypeResource
Descriptiondatabases
Idawscc.timestream.databases
+ +## Fields + + + + + +
NameDatatypeDescription
database_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the databases resource, the following permissions are required: + +### Create +
+timestream:CreateDatabase,
+timestream:DescribeEndpoints,
+timestream:TagResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:Decrypt
+ +### List +
+timestream:ListDatabases,
+timestream:DescribeEndpoints
+ + +## Example +```sql +SELECT +region, +database_name +FROM awscc.timestream.databases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/timestream/index.md b/docs/awscc-docs/providers/awscc/timestream/index.md new file mode 100644 index 0000000000..0002dfce82 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/timestream/index.md @@ -0,0 +1,43 @@ +--- +title: timestream +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The timestream service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+database
+databases
+scheduled_queries +
+
+scheduled_query
+table
+tables +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/timestream/scheduled_queries/index.md b/docs/awscc-docs/providers/awscc/timestream/scheduled_queries/index.md new file mode 100644 index 0000000000..556a64198d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/timestream/scheduled_queries/index.md @@ -0,0 +1,60 @@ +--- +title: scheduled_queries +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_queries + - 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 +--- +Retrieves a list of scheduled_queries in a region + +## Overview + + + + + +
Namescheduled_queries
TypeResource
Descriptionscheduled_queries
Idawscc.timestream.scheduled_queries
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_queries resource, the following permissions are required: + +### Create +
+timestream:CreateScheduledQuery,
+timestream:DescribeEndpoints
+ +### List +
+timestream:ListScheduledQueries,
+timestream:DescribeEndpoints
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.timestream.scheduled_queries +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md b/docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md new file mode 100644 index 0000000000..32251e9d6b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md @@ -0,0 +1,105 @@ +--- +title: scheduled_query +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_query + - 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 +--- +Gets an individual scheduled_query resource + +## Overview + + + + + +
Namescheduled_query
TypeResource
Descriptionscheduled_query
Idawscc.timestream.scheduled_query
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
scheduled_query_namestring
query_stringstring
schedule_configurationobject
notification_configurationobject
client_tokenstring
scheduled_query_execution_role_arnstring
target_configurationobject
error_report_configurationobject
kms_key_idstring
s_qnamestringThe name of the scheduled query. Scheduled query names must be unique within each Region.
s_qquery_stringstringThe 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.
s_qschedule_configurationstringConfiguration for when the scheduled query is executed.
s_qnotification_configurationstringNotification 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.
s_qscheduled_query_execution_role_arnstringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
s_qtarget_configurationstringConfiguration of target store where scheduled query results are written to.
s_qerror_report_configurationstringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
s_qkms_key_idstringThe 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.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the scheduled_query resource, the following permissions are required: + +### Read +
+timestream:DescribeScheduledQuery,
+timestream:ListTagsForResource,
+timestream:DescribeEndpoints
+ +### Update +
+timestream:UpdateScheduledQuery,
+timestream:TagResource,
+timestream:UntagResource,
+timestream:DescribeEndpoints
+ +### Delete +
+timestream:DeleteScheduledQuery,
+timestream:DescribeEndpoints
+ + +## Example +```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, +s_qname, +s_qquery_string, +s_qschedule_configuration, +s_qnotification_configuration, +s_qscheduled_query_execution_role_arn, +s_qtarget_configuration, +s_qerror_report_configuration, +s_qkms_key_id, +tags +FROM awscc.timestream.scheduled_query +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/timestream/table/index.md b/docs/awscc-docs/providers/awscc/timestream/table/index.md new file mode 100644 index 0000000000..8ca30b7cf3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/timestream/table/index.md @@ -0,0 +1,91 @@ +--- +title: table +hide_title: false +hide_table_of_contents: false +keywords: + - table + - 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 +--- +Gets an individual table resource + +## Overview + + + + + +
Nametable
TypeResource
Descriptiontable
Idawscc.timestream.table
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
namestringThe table name exposed as a read-only attribute.
database_namestringThe name for the database which the table to be created belongs to.
table_namestringThe 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.
retention_propertiesobjectThe retention duration of the memory store and the magnetic store.
schemaobjectA Schema specifies the expected data model of the table.
magnetic_store_write_propertiesobjectThe properties that determine whether magnetic store writes are enabled.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the table resource, the following permissions are required: + +### Read +
+timestream:DescribeTable,
+timestream:DescribeEndpoints,
+timestream:ListTagsForResource
+ +### Update +
+timestream:UpdateTable,
+timestream:DescribeEndpoints,
+timestream:TagResource,
+timestream:UntagResource,
+s3:PutObject,
+s3:GetObject,
+s3:GetBucketAcl,
+kms:GenerateDataKey*,
+kms:DescribeKey,
+kms:Encrypt
+ +### Delete +
+timestream:DeleteTable,
+timestream:DescribeEndpoints,
+timestream:DescribeTable
+ + +## Example +```sql +SELECT +region, +arn, +name, +database_name, +table_name, +retention_properties, +schema, +magnetic_store_write_properties, +tags +FROM awscc.timestream.table +WHERE region = 'us-east-1' +AND data__Identifier = '<DatabaseName>' +AND data__Identifier = '<TableName>' +``` diff --git a/docs/awscc-docs/providers/awscc/timestream/tables/index.md b/docs/awscc-docs/providers/awscc/timestream/tables/index.md new file mode 100644 index 0000000000..f3a8ed6e45 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/timestream/tables/index.md @@ -0,0 +1,69 @@ +--- +title: tables +hide_title: false +hide_table_of_contents: false +keywords: + - tables + - 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 +--- +Retrieves a list of tables in a region + +## Overview + + + + + +
Nametables
TypeResource
Descriptiontables
Idawscc.timestream.tables
+ +## Fields + + + + + + +
NameDatatypeDescription
database_namestringThe name for the database which the table to be created belongs to.
table_namestringThe 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the tables resource, the following permissions are required: + +### Create +
+timestream:CreateTable,
+timestream:DescribeEndpoints,
+timestream:TagResource,
+s3:PutObject,
+s3:GetObject,
+s3:GetBucketAcl,
+kms:GenerateDataKey*,
+kms:DescribeKey,
+kms:Encrypt
+ +### List +
+timestream:ListTables,
+timestream:DescribeEndpoints
+ + +## Example +```sql +SELECT +region, +database_name, +table_name +FROM awscc.timestream.tables +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/agreement/index.md b/docs/awscc-docs/providers/awscc/transfer/agreement/index.md new file mode 100644 index 0000000000..eff9dc07c6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/agreement/index.md @@ -0,0 +1,85 @@ +--- +title: agreement +hide_title: false +hide_table_of_contents: false +keywords: + - agreement + - 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 +--- +Gets an individual agreement resource + +## Overview + + + + + +
Nameagreement
TypeResource
Descriptionagreement
Idawscc.transfer.agreement
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA textual description for the agreement.
server_idstringA unique identifier for the server.
local_profile_idstringA unique identifier for the local profile.
partner_profile_idstringA unique identifier for the partner profile.
base_directorystringSpecifies the base directory for the agreement.
access_rolestringSpecifies the access role for the agreement.
statusstringSpecifies the status of the agreement.
tagsarrayKey-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
agreement_idstringA unique identifier for the agreement.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the agreement resource, the following permissions are required: + +### Read +
+transfer:DescribeAgreement
+ +### Update +
+transfer:UpdateAgreement,
+transfer:UnTagResource,
+transfer:TagResource,
+iam:PassRole
+ +### Delete +
+transfer:DeleteAgreement
+ + +## Example +```sql +SELECT +region, +description, +server_id, +local_profile_id, +partner_profile_id, +base_directory, +access_role, +status, +tags, +agreement_id, +arn +FROM awscc.transfer.agreement +WHERE region = 'us-east-1' +AND data__Identifier = '<AgreementId>' +AND data__Identifier = '<ServerId>' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/agreements/index.md b/docs/awscc-docs/providers/awscc/transfer/agreements/index.md new file mode 100644 index 0000000000..d0f510a9f7 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/agreements/index.md @@ -0,0 +1,62 @@ +--- +title: agreements +hide_title: false +hide_table_of_contents: false +keywords: + - agreements + - 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 +--- +Retrieves a list of agreements in a region + +## Overview + + + + + +
Nameagreements
TypeResource
Descriptionagreements
Idawscc.transfer.agreements
+ +## Fields + + + + + + +
NameDatatypeDescription
agreement_idstringA unique identifier for the agreement.
server_idstringA unique identifier for the server.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the agreements resource, the following permissions are required: + +### Create +
+transfer:CreateAgreement,
+transfer:TagResource,
+iam:PassRole
+ +### List +
+transfer:ListAgreements
+ + +## Example +```sql +SELECT +region, +agreement_id, +server_id +FROM awscc.transfer.agreements +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/certificate/index.md b/docs/awscc-docs/providers/awscc/transfer/certificate/index.md new file mode 100644 index 0000000000..d099920a7e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/certificate/index.md @@ -0,0 +1,93 @@ +--- +title: certificate +hide_title: false +hide_table_of_contents: false +keywords: + - certificate + - 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 +--- +Gets an individual certificate resource + +## Overview + + + + + +
Namecertificate
TypeResource
Descriptioncertificate
Idawscc.transfer.certificate
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
usagestringSpecifies the usage type for the certificate.
certificatestringSpecifies the certificate body to be imported.
certificate_chainstringSpecifies the certificate chain to be imported.
private_keystringSpecifies the private key for the certificate.
active_datestringSpecifies the active date for the certificate.
inactive_datestringSpecifies the inactive date for the certificate.
descriptionstringA textual description for the certificate.
tagsarrayKey-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
certificate_idstringA unique identifier for the certificate.
statusstringA status description for the certificate.
typestringDescribing the type of certificate. With or without a private key.
serialstringSpecifies Certificate's serial.
not_before_datestringSpecifies the not before date for the certificate.
not_after_datestringSpecifies the not after date for the certificate.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +
+transfer:DescribeCertificate
+ +### Update +
+transfer:UpdateCertificate,
+transfer:UnTagResource,
+transfer:TagResource
+ +### Delete +
+transfer:DeleteCertificate
+ + +## Example +```sql +SELECT +region, +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 awscc.transfer.certificate +WHERE region = 'us-east-1' +AND data__Identifier = '<CertificateId>' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/certificates/index.md b/docs/awscc-docs/providers/awscc/transfer/certificates/index.md new file mode 100644 index 0000000000..c781b62b34 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/certificates/index.md @@ -0,0 +1,59 @@ +--- +title: certificates +hide_title: false +hide_table_of_contents: false +keywords: + - certificates + - 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 +--- +Retrieves a list of certificates in a region + +## Overview + + + + + +
Namecertificates
TypeResource
Descriptioncertificates
Idawscc.transfer.certificates
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_idstringA unique identifier for the certificate.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +
+transfer:ImportCertificate,
+transfer:TagResource
+ +### List +
+transfer:ListCertificates
+ + +## Example +```sql +SELECT +region, +certificate_id +FROM awscc.transfer.certificates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/connector/index.md b/docs/awscc-docs/providers/awscc/transfer/connector/index.md new file mode 100644 index 0000000000..85c5a050c4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/connector/index.md @@ -0,0 +1,80 @@ +--- +title: connector +hide_title: false +hide_table_of_contents: false +keywords: + - connector + - 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 +--- +Gets an individual connector resource + +## Overview + + + + + +
Nameconnector
TypeResource
Descriptionconnector
Idawscc.transfer.connector
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
access_rolestringSpecifies the access role for the connector.
as2_configobjectConfiguration for an AS2 connector.
sftp_configobjectConfiguration for an SFTP connector.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the connector.
connector_idstringA unique identifier for the connector.
logging_rolestringSpecifies the logging role for the connector.
tagsarrayKey-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
urlstringURL for Connector
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +
+transfer:DescribeConnector
+ +### Update +
+transfer:UpdateConnector,
+transfer:UnTagResource,
+transfer:TagResource,
+iam:PassRole
+ +### Delete +
+transfer:DeleteConnector
+ + +## Example +```sql +SELECT +region, +access_role, +as2_config, +sftp_config, +arn, +connector_id, +logging_role, +tags, +url +FROM awscc.transfer.connector +WHERE region = 'us-east-1' +AND data__Identifier = '<ConnectorId>' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/connectors/index.md b/docs/awscc-docs/providers/awscc/transfer/connectors/index.md new file mode 100644 index 0000000000..05f7f44a40 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/connectors/index.md @@ -0,0 +1,60 @@ +--- +title: connectors +hide_title: false +hide_table_of_contents: false +keywords: + - connectors + - 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 +--- +Retrieves a list of connectors in a region + +## Overview + + + + + +
Nameconnectors
TypeResource
Descriptionconnectors
Idawscc.transfer.connectors
+ +## Fields + + + + + +
NameDatatypeDescription
connector_idstringA unique identifier for the connector.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +
+transfer:CreateConnector,
+transfer:TagResource,
+iam:PassRole
+ +### List +
+transfer:ListConnectors
+ + +## Example +```sql +SELECT +region, +connector_id +FROM awscc.transfer.connectors +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/index.md b/docs/awscc-docs/providers/awscc/transfer/index.md new file mode 100644 index 0000000000..6ba379da3a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/index.md @@ -0,0 +1,47 @@ +--- +title: transfer +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The transfer service documentation. + +:::info Service Summary + +
+
+total resources: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+agreement
+agreements
+certificate
+certificates
+connector +
+
+connectors
+profile
+profiles
+workflow
+workflows +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/transfer/profile/index.md b/docs/awscc-docs/providers/awscc/transfer/profile/index.md new file mode 100644 index 0000000000..0632130dc4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/profile/index.md @@ -0,0 +1,75 @@ +--- +title: profile +hide_title: false +hide_table_of_contents: false +keywords: + - profile + - 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 +--- +Gets an individual profile resource + +## Overview + + + + + +
Nameprofile
TypeResource
Descriptionprofile
Idawscc.transfer.profile
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
as2_idstringAS2 identifier agreed with a trading partner.
profile_typestringEnum specifying whether the profile is local or associated with a trading partner.
tagsarrayAn array of key-value pairs to apply to this resource.
certificate_idsarrayList of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the profile.
profile_idstringA unique identifier for the profile
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profile resource, the following permissions are required: + +### Read +
+transfer:DescribeProfile
+ +### Update +
+transfer:UpdateProfile,
+transfer:UnTagResource,
+transfer:TagResource
+ +### Delete +
+transfer:DeleteProfile
+ + +## Example +```sql +SELECT +region, +as2_id, +profile_type, +tags, +certificate_ids, +arn, +profile_id +FROM awscc.transfer.profile +WHERE region = 'us-east-1' +AND data__Identifier = '<ProfileId>' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/profiles/index.md b/docs/awscc-docs/providers/awscc/transfer/profiles/index.md new file mode 100644 index 0000000000..be197364e6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/profiles/index.md @@ -0,0 +1,59 @@ +--- +title: profiles +hide_title: false +hide_table_of_contents: false +keywords: + - profiles + - 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 +--- +Retrieves a list of profiles in a region + +## Overview + + + + + +
Nameprofiles
TypeResource
Descriptionprofiles
Idawscc.transfer.profiles
+ +## Fields + + + + + +
NameDatatypeDescription
profile_idstringA unique identifier for the profile
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +
+transfer:CreateProfile,
+transfer:TagResource
+ +### List +
+transfer:ListProfiles
+ + +## Example +```sql +SELECT +region, +profile_id +FROM awscc.transfer.profiles +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/workflow/index.md b/docs/awscc-docs/providers/awscc/transfer/workflow/index.md new file mode 100644 index 0000000000..d27e90414e --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/workflow/index.md @@ -0,0 +1,74 @@ +--- +title: workflow +hide_title: false +hide_table_of_contents: false +keywords: + - workflow + - 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 +--- +Gets an individual workflow resource + +## Overview + + + + + +
Nameworkflow
TypeResource
Descriptionworkflow
Idawscc.transfer.workflow
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
on_exception_stepsarraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
stepsarraySpecifies the details for the steps that are in the specified workflow.
tagsarrayKey-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
descriptionstringA textual description for the workflow.
workflow_idstringA unique identifier for the workflow.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the workflow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workflow resource, the following permissions are required: + +### Read +
+transfer:DescribeWorkflow
+ +### Delete +
+transfer:DeleteWorkflow
+ +### Update +
+transfer:UnTagResource,
+transfer:TagResource
+ + +## Example +```sql +SELECT +region, +on_exception_steps, +steps, +tags, +description, +workflow_id, +arn +FROM awscc.transfer.workflow +WHERE region = 'us-east-1' +AND data__Identifier = '<WorkflowId>' +``` diff --git a/docs/awscc-docs/providers/awscc/transfer/workflows/index.md b/docs/awscc-docs/providers/awscc/transfer/workflows/index.md new file mode 100644 index 0000000000..1337b05264 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/transfer/workflows/index.md @@ -0,0 +1,59 @@ +--- +title: workflows +hide_title: false +hide_table_of_contents: false +keywords: + - workflows + - 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 +--- +Retrieves a list of workflows in a region + +## Overview + + + + + +
Nameworkflows
TypeResource
Descriptionworkflows
Idawscc.transfer.workflows
+ +## Fields + + + + + +
NameDatatypeDescription
workflow_idstringA unique identifier for the workflow.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +
+transfer:CreateWorkflow,
+transfer:TagResource
+ +### List +
+transfer:ListWorkflows
+ + +## Example +```sql +SELECT +region, +workflow_id +FROM awscc.transfer.workflows +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md new file mode 100644 index 0000000000..3c1b5872db --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md @@ -0,0 +1,90 @@ +--- +title: identity_source +hide_title: false +hide_table_of_contents: false +keywords: + - identity_source + - 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 +--- +Gets an individual identity_source resource + +## Overview + + + + + +
Nameidentity_source
TypeResource
Descriptionidentity_source
Idawscc.verifiedpermissions.identity_source
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
configurationobject
detailsobject
identity_source_idstring
policy_store_idstring
principal_entity_typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_source resource, the following permissions are required: + +### Read +
+verifiedpermissions:CreateIdentitySource,
+verifiedpermissions:GetIdentitySource,
+verifiedpermissions:UpdateIdentitySource,
+verifiedpermissions:DeleteIdentitySource,
+verifiedpermissions:ListIdentitySources,
+cognito-idp:DescribeUserPool,
+cognito-idp:ListUserPoolClients
+ +### Update +
+verifiedpermissions:CreateIdentitySource,
+verifiedpermissions:GetIdentitySource,
+verifiedpermissions:UpdateIdentitySource,
+verifiedpermissions:DeleteIdentitySource,
+verifiedpermissions:ListIdentitySources,
+cognito-idp:DescribeUserPool,
+cognito-idp:ListUserPoolClients
+ +### Delete +
+verifiedpermissions:CreateIdentitySource,
+verifiedpermissions:GetIdentitySource,
+verifiedpermissions:UpdateIdentitySource,
+verifiedpermissions:DeleteIdentitySource,
+verifiedpermissions:ListIdentitySources,
+cognito-idp:DescribeUserPool,
+cognito-idp:ListUserPoolClients
+ + +## Example +```sql +SELECT +region, +configuration, +details, +identity_source_id, +policy_store_id, +principal_entity_type +FROM awscc.verifiedpermissions.identity_source +WHERE region = 'us-east-1' +AND data__Identifier = '<IdentitySourceId>' +AND data__Identifier = '<PolicyStoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md new file mode 100644 index 0000000000..d6640e02bc --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md @@ -0,0 +1,72 @@ +--- +title: identity_sources +hide_title: false +hide_table_of_contents: false +keywords: + - identity_sources + - 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 +--- +Retrieves a list of identity_sources in a region + +## Overview + + + + + +
Nameidentity_sources
TypeResource
Descriptionidentity_sources
Idawscc.verifiedpermissions.identity_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
identity_source_idstring
policy_store_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_sources resource, the following permissions are required: + +### Create +
+verifiedpermissions:CreateIdentitySource,
+verifiedpermissions:GetIdentitySource,
+verifiedpermissions:UpdateIdentitySource,
+verifiedpermissions:DeleteIdentitySource,
+verifiedpermissions:ListIdentitySources,
+cognito-idp:DescribeUserPool,
+cognito-idp:ListUserPoolClients
+ +### List +
+verifiedpermissions:CreateIdentitySource,
+verifiedpermissions:GetIdentitySource,
+verifiedpermissions:UpdateIdentitySource,
+verifiedpermissions:DeleteIdentitySource,
+verifiedpermissions:ListIdentitySources,
+cognito-idp:DescribeUserPool,
+cognito-idp:ListUserPoolClients
+ + +## Example +```sql +SELECT +region, +identity_source_id, +policy_store_id +FROM awscc.verifiedpermissions.identity_sources +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/index.md new file mode 100644 index 0000000000..3179be3609 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/index.md @@ -0,0 +1,45 @@ +--- +title: verifiedpermissions +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The verifiedpermissions service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+identity_source
+identity_sources
+policies
+policy +
+
+policy_store
+policy_stores
+policy_template
+policy_templates +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policies/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policies/index.md new file mode 100644 index 0000000000..eb2d153df4 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/policies/index.md @@ -0,0 +1,66 @@ +--- +title: policies +hide_title: false +hide_table_of_contents: false +keywords: + - policies + - 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 +--- +Retrieves a list of policies in a region + +## Overview + + + + + +
Namepolicies
TypeResource
Descriptionpolicies
Idawscc.verifiedpermissions.policies
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_idstring
policy_store_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +
+verifiedpermissions:CreatePolicy,
+verifiedpermissions:GetPolicy,
+verifiedpermissions:UpdatePolicy,
+verifiedpermissions:DeletePolicy
+ +### List +
+verifiedpermissions:CreatePolicy,
+verifiedpermissions:GetPolicy,
+verifiedpermissions:UpdatePolicy,
+verifiedpermissions:DeletePolicy
+ + +## Example +```sql +SELECT +region, +policy_id, +policy_store_id +FROM awscc.verifiedpermissions.policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md new file mode 100644 index 0000000000..d14b5acbeb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md @@ -0,0 +1,79 @@ +--- +title: policy +hide_title: false +hide_table_of_contents: false +keywords: + - policy + - 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 +--- +Gets an individual policy resource + +## Overview + + + + + +
Namepolicy
TypeResource
Descriptionpolicy
Idawscc.verifiedpermissions.policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
definitionundefined
policy_idstring
policy_store_idstring
policy_typestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Read +
+verifiedpermissions:CreatePolicy,
+verifiedpermissions:GetPolicy,
+verifiedpermissions:UpdatePolicy,
+verifiedpermissions:DeletePolicy
+ +### Update +
+verifiedpermissions:CreatePolicy,
+verifiedpermissions:GetPolicy,
+verifiedpermissions:UpdatePolicy,
+verifiedpermissions:DeletePolicy
+ +### Delete +
+verifiedpermissions:CreatePolicy,
+verifiedpermissions:GetPolicy,
+verifiedpermissions:UpdatePolicy,
+verifiedpermissions:DeletePolicy
+ + +## Example +```sql +SELECT +region, +definition, +policy_id, +policy_store_id, +policy_type +FROM awscc.verifiedpermissions.policy +WHERE region = 'us-east-1' +AND data__Identifier = '<PolicyId>' +AND data__Identifier = '<PolicyStoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md new file mode 100644 index 0000000000..bc1cffdd5a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md @@ -0,0 +1,83 @@ +--- +title: policy_store +hide_title: false +hide_table_of_contents: false +keywords: + - policy_store + - 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 +--- +Gets an individual policy_store resource + +## Overview + + + + + +
Namepolicy_store
TypeResource
Descriptionpolicy_store
Idawscc.verifiedpermissions.policy_store
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
descriptionstring
policy_store_idstring
validation_settingsobject
schemaobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy_store resource, the following permissions are required: + +### Read +
+verifiedpermissions:CreatePolicyStore,
+verifiedpermissions:GetPolicyStore,
+verifiedpermissions:UpdatePolicyStore,
+verifiedpermissions:DeletePolicyStore,
+verifiedpermissions:GetSchema
+ +### Update +
+verifiedpermissions:CreatePolicyStore,
+verifiedpermissions:GetPolicyStore,
+verifiedpermissions:UpdatePolicyStore,
+verifiedpermissions:DeletePolicyStore,
+verifiedpermissions:GetSchema,
+verifiedpermissions:PutSchema
+ +### Delete +
+verifiedpermissions:CreatePolicyStore,
+verifiedpermissions:GetPolicyStore,
+verifiedpermissions:UpdatePolicyStore,
+verifiedpermissions:DeletePolicyStore
+ + +## Example +```sql +SELECT +region, +arn, +description, +policy_store_id, +validation_settings, +schema +FROM awscc.verifiedpermissions.policy_store +WHERE region = 'us-east-1' +AND data__Identifier = '<PolicyStoreId>' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md new file mode 100644 index 0000000000..0a6de6f043 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md @@ -0,0 +1,67 @@ +--- +title: policy_stores +hide_title: false +hide_table_of_contents: false +keywords: + - policy_stores + - 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 +--- +Retrieves a list of policy_stores in a region + +## Overview + + + + + +
Namepolicy_stores
TypeResource
Descriptionpolicy_stores
Idawscc.verifiedpermissions.policy_stores
+ +## Fields + + + + + +
NameDatatypeDescription
policy_store_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy_stores resource, the following permissions are required: + +### Create +
+verifiedpermissions:CreatePolicyStore,
+verifiedpermissions:GetPolicyStore,
+verifiedpermissions:UpdatePolicyStore,
+verifiedpermissions:DeletePolicyStore,
+verifiedpermissions:PutSchema
+ +### List +
+verifiedpermissions:CreatePolicyStore,
+verifiedpermissions:GetPolicyStore,
+verifiedpermissions:UpdatePolicyStore,
+verifiedpermissions:DeletePolicyStore,
+verifiedpermissions:ListPolicyStores,
+verifiedpermissions:GetSchema
+ + +## Example +```sql +SELECT +region, +policy_store_id +FROM awscc.verifiedpermissions.policy_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md new file mode 100644 index 0000000000..599d6dee91 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md @@ -0,0 +1,79 @@ +--- +title: policy_template +hide_title: false +hide_table_of_contents: false +keywords: + - policy_template + - 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 +--- +Gets an individual policy_template resource + +## Overview + + + + + +
Namepolicy_template
TypeResource
Descriptionpolicy_template
Idawscc.verifiedpermissions.policy_template
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstring
policy_store_idstring
policy_template_idstring
statementstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy_template resource, the following permissions are required: + +### Read +
+verifiedpermissions:CreatePolicyTemplate,
+verifiedpermissions:GetPolicyTemplate,
+verifiedpermissions:UpdatePolicyTemplate,
+verifiedpermissions:DeletePolicyTemplate
+ +### Update +
+verifiedpermissions:CreatePolicyTemplate,
+verifiedpermissions:GetPolicyTemplate,
+verifiedpermissions:UpdatePolicyTemplate,
+verifiedpermissions:DeletePolicyTemplate
+ +### Delete +
+verifiedpermissions:CreatePolicyTemplate,
+verifiedpermissions:GetPolicyTemplate,
+verifiedpermissions:UpdatePolicyTemplate,
+verifiedpermissions:DeletePolicyTemplate
+ + +## Example +```sql +SELECT +region, +description, +policy_store_id, +policy_template_id, +statement +FROM awscc.verifiedpermissions.policy_template +WHERE region = 'us-east-1' +AND data__Identifier = '<PolicyStoreId>' +AND data__Identifier = '<PolicyTemplateId>' +``` diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md new file mode 100644 index 0000000000..f1d0ade52a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md @@ -0,0 +1,67 @@ +--- +title: policy_templates +hide_title: false +hide_table_of_contents: false +keywords: + - policy_templates + - 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 +--- +Retrieves a list of policy_templates in a region + +## Overview + + + + + +
Namepolicy_templates
TypeResource
Descriptionpolicy_templates
Idawscc.verifiedpermissions.policy_templates
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_store_idstring
policy_template_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the policy_templates resource, the following permissions are required: + +### Create +
+verifiedpermissions:CreatePolicyTemplate,
+verifiedpermissions:GetPolicyTemplate,
+verifiedpermissions:UpdatePolicyTemplate,
+verifiedpermissions:DeletePolicyTemplate
+ +### List +
+verifiedpermissions:CreatePolicyTemplate,
+verifiedpermissions:GetPolicyTemplate,
+verifiedpermissions:UpdatePolicyTemplate,
+verifiedpermissions:DeletePolicyTemplate,
+verifiedpermissions:ListPolicyTemplates
+ + +## Example +```sql +SELECT +region, +policy_store_id, +policy_template_id +FROM awscc.verifiedpermissions.policy_templates +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/voiceid/domain/index.md b/docs/awscc-docs/providers/awscc/voiceid/domain/index.md new file mode 100644 index 0000000000..08aa66c02d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/voiceid/domain/index.md @@ -0,0 +1,82 @@ +--- +title: domain +hide_title: false +hide_table_of_contents: false +keywords: + - domain + - 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 +--- +Gets an individual domain resource + +## Overview + + + + + +
Namedomain
TypeResource
Descriptiondomain
Idawscc.voiceid.domain
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstring
domain_idstring
namestring
server_side_encryption_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +
+voiceid:DescribeDomain,
+voiceid:ListTagsForResource,
+kms:Decrypt
+ +### Update +
+voiceid:DescribeDomain,
+voiceid:UpdateDomain,
+voiceid:TagResource,
+voiceid:UntagResource,
+voiceid:ListTagsForResource,
+kms:CreateGrant,
+kms:Decrypt,
+kms:DescribeKey
+ +### Delete +
+voiceid:DeleteDomain,
+voiceid:DescribeDomain,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +description, +domain_id, +name, +server_side_encryption_configuration, +tags +FROM awscc.voiceid.domain +WHERE region = 'us-east-1' +AND data__Identifier = '<DomainId>' +``` diff --git a/docs/awscc-docs/providers/awscc/voiceid/domains/index.md b/docs/awscc-docs/providers/awscc/voiceid/domains/index.md new file mode 100644 index 0000000000..310d09f820 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/voiceid/domains/index.md @@ -0,0 +1,65 @@ +--- +title: domains +hide_title: false +hide_table_of_contents: false +keywords: + - domains + - 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 +--- +Retrieves a list of domains in a region + +## Overview + + + + + +
Namedomains
TypeResource
Descriptiondomains
Idawscc.voiceid.domains
+ +## Fields + + + + + +
NameDatatypeDescription
domain_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +
+voiceid:CreateDomain,
+voiceid:DescribeDomain,
+voiceid:TagResource,
+voiceid:ListTagsForResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:Decrypt
+ +### List +
+voiceid:ListDomains,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +domain_id +FROM awscc.voiceid.domains +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/voiceid/index.md b/docs/awscc-docs/providers/awscc/voiceid/index.md new file mode 100644 index 0000000000..41bb546b13 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/voiceid/index.md @@ -0,0 +1,39 @@ +--- +title: voiceid +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The voiceid service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+domain +
+
+domains +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscription/index.md b/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscription/index.md new file mode 100644 index 0000000000..fdc451561b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscription/index.md @@ -0,0 +1,107 @@ +--- +title: access_log_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - access_log_subscription + - 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 +--- +Gets an individual access_log_subscription resource + +## Overview + + + + + +
Nameaccess_log_subscription
TypeResource
Descriptionaccess_log_subscription
Idawscc.vpclattice.access_log_subscription
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
destination_arnstring
idstring
resource_arnstring
resource_idstring
resource_identifierstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_log_subscription resource, the following permissions are required: + +### Read +
+vpc-lattice:GetAccessLogSubscription,
+vpc-lattice:ListTagsForResource,
+logs:GetLogDelivery
+ +### Update +
+vpc-lattice:GetAccessLogSubscription,
+vpc-lattice:UpdateAccessLogSubscription,
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource,
+logs:UpdateLogDelivery,
+firehose:UpdateDestination,
+logs:CreateLogDelivery,
+logs:CreateLogStream,
+logs:PutDestination,
+logs:PutDestinationPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+logs:GetLogDelivery,
+s3:PutBucketLogging,
+s3:GetBucketLogging,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+firehose:TagDeliveryStream,
+firehose:CreateDeliveryStream,
+firehose:DescribeDeliveryStream
+ +### Delete +
+vpc-lattice:DeleteAccessLogSubscription,
+vpc-lattice:UntagResource,
+logs:DeleteLogDelivery,
+logs:DeleteLogStream,
+logs:GetLogDelivery,
+logs:DeleteDestination,
+s3:PutBucketLogging,
+iam:GetServiceLinkedRoleDeletionStatus,
+iam:DeleteServiceLinkedRole,
+firehose:DeleteDeliveryStream,
+firehose:UntagDeliveryStream
+ + +## Example +```sql +SELECT +region, +arn, +destination_arn, +id, +resource_arn, +resource_id, +resource_identifier, +tags +FROM awscc.vpclattice.access_log_subscription +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscriptions/index.md b/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscriptions/index.md new file mode 100644 index 0000000000..f6ac51389d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscriptions/index.md @@ -0,0 +1,77 @@ +--- +title: access_log_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - access_log_subscriptions + - 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 +--- +Retrieves a list of access_log_subscriptions in a region + +## Overview + + + + + +
Nameaccess_log_subscriptions
TypeResource
Descriptionaccess_log_subscriptions
Idawscc.vpclattice.access_log_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the access_log_subscriptions resource, the following permissions are required: + +### Create +
+vpc-lattice:CreateAccessLogSubscription,
+vpc-lattice:TagResource,
+vpc-lattice:GetAccessLogSubscription,
+vpc-lattice:ListTagsForResource,
+logs:CreateLogDelivery,
+logs:CreateLogStream,
+logs:PutDestination,
+logs:PutDestinationPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups,
+logs:GetLogDelivery,
+s3:PutBucketLogging,
+s3:GetBucketLogging,
+s3:GetBucketPolicy,
+s3:PutBucketPolicy,
+firehose:TagDeliveryStream,
+firehose:CreateDeliveryStream,
+firehose:DescribeDeliveryStream,
+iam:CreateServiceLinkedRole
+ +### List +
+vpc-lattice:ListAccessLogSubscriptions
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.access_log_subscriptions +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/auth_policies/index.md b/docs/awscc-docs/providers/awscc/vpclattice/auth_policies/index.md new file mode 100644 index 0000000000..31437cb7ff --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/auth_policies/index.md @@ -0,0 +1,55 @@ +--- +title: auth_policies +hide_title: false +hide_table_of_contents: false +keywords: + - auth_policies + - 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 +--- +Retrieves a list of auth_policies in a region + +## Overview + + + + + +
Nameauth_policies
TypeResource
Descriptionauth_policies
Idawscc.vpclattice.auth_policies
+ +## Fields + + + + + +
NameDatatypeDescription
resource_identifierstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the auth_policies resource, the following permissions are required: + +### Create +
+vpc-lattice:GetAuthPolicy,
+vpc-lattice:PutAuthPolicy
+ + +## Example +```sql +SELECT +region, +resource_identifier +FROM awscc.vpclattice.auth_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md b/docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md new file mode 100644 index 0000000000..d2632b1518 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md @@ -0,0 +1,69 @@ +--- +title: auth_policy +hide_title: false +hide_table_of_contents: false +keywords: + - auth_policy + - 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 +--- +Gets an individual auth_policy resource + +## Overview + + + + + +
Nameauth_policy
TypeResource
Descriptionauth_policy
Idawscc.vpclattice.auth_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
resource_identifierstring
policyobject
statestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the auth_policy resource, the following permissions are required: + +### Read +
+vpc-lattice:GetAuthPolicy
+ +### Update +
+vpc-lattice:GetAuthPolicy,
+vpc-lattice:PutAuthPolicy
+ +### Delete +
+vpc-lattice:GetAuthPolicy,
+vpc-lattice:DeleteAuthPolicy
+ + +## Example +```sql +SELECT +region, +resource_identifier, +policy, +state +FROM awscc.vpclattice.auth_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceIdentifier>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/index.md b/docs/awscc-docs/providers/awscc/vpclattice/index.md new file mode 100644 index 0000000000..cf7f3d3bca --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/index.md @@ -0,0 +1,57 @@ +--- +title: vpclattice +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The vpclattice service documentation. + +:::info Service Summary + +
+
+total resources: 20
+total selectable resources: 20
+total methods: 20
+
+
+ +::: + +## Resources +
+
+access_log_subscription
+access_log_subscriptions
+auth_policies
+auth_policy
+listener
+listeners
+resource_policies
+resource_policy
+rule
+rules +
+
+service
+service_network
+service_network_service_association
+service_network_service_associations
+service_network_vpc_association
+service_network_vpc_associations
+service_networks
+services
+target_group
+target_groups +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/vpclattice/listener/index.md b/docs/awscc-docs/providers/awscc/vpclattice/listener/index.md new file mode 100644 index 0000000000..84410f8861 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/listener/index.md @@ -0,0 +1,86 @@ +--- +title: listener +hide_title: false +hide_table_of_contents: false +keywords: + - listener + - 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 +--- +Gets an individual listener resource + +## Overview + + + + + +
Namelistener
TypeResource
Descriptionlistener
Idawscc.vpclattice.listener
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
default_actionobject
idstring
namestring
portinteger
protocolstring
service_arnstring
service_idstring
service_identifierstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listener resource, the following permissions are required: + +### Read +
+vpc-lattice:GetListener,
+vpc-lattice:ListTagsForResource
+ +### Update +
+vpc-lattice:UpdateListener,
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource,
+vpc-lattice:GetListener,
+vpc-lattice:ListTagsForResource
+ +### Delete +
+vpc-lattice:DeleteListener
+ + +## Example +```sql +SELECT +region, +arn, +default_action, +id, +name, +port, +protocol, +service_arn, +service_id, +service_identifier, +tags +FROM awscc.vpclattice.listener +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md b/docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md new file mode 100644 index 0000000000..ccf5acece3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md @@ -0,0 +1,61 @@ +--- +title: listeners +hide_title: false +hide_table_of_contents: false +keywords: + - listeners + - 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 +--- +Retrieves a list of listeners in a region + +## Overview + + + + + +
Namelisteners
TypeResource
Descriptionlisteners
Idawscc.vpclattice.listeners
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Create +
+vpc-lattice:CreateListener,
+vpc-lattice:TagResource,
+vpc-lattice:GetListener,
+vpc-lattice:ListTagsForResource
+ +### List +
+vpc-lattice:ListListeners
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.listeners +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/resource_policies/index.md b/docs/awscc-docs/providers/awscc/vpclattice/resource_policies/index.md new file mode 100644 index 0000000000..57c18efc22 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/resource_policies/index.md @@ -0,0 +1,55 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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 +--- +Retrieves a list of resource_policies in a region + +## Overview + + + + + +
Nameresource_policies
TypeResource
Descriptionresource_policies
Idawscc.vpclattice.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
resource_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +
+vpc-lattice:GetResourcePolicy,
+vpc-lattice:PutResourcePolicy
+ + +## Example +```sql +SELECT +region, +resource_arn +FROM awscc.vpclattice.resource_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md b/docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md new file mode 100644 index 0000000000..237c096cb9 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md @@ -0,0 +1,67 @@ +--- +title: resource_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy + - 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 +--- +Gets an individual resource_policy resource + +## Overview + + + + + +
Nameresource_policy
TypeResource
Descriptionresource_policy
Idawscc.vpclattice.resource_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_arnstring
policyobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +
+vpc-lattice:GetResourcePolicy
+ +### Update +
+vpc-lattice:GetResourcePolicy,
+vpc-lattice:PutResourcePolicy
+ +### Delete +
+vpc-lattice:GetResourcePolicy,
+vpc-lattice:DeleteResourcePolicy
+ + +## Example +```sql +SELECT +region, +resource_arn, +policy +FROM awscc.vpclattice.resource_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<ResourceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/rule/index.md b/docs/awscc-docs/providers/awscc/vpclattice/rule/index.md new file mode 100644 index 0000000000..1a4a0f0f92 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/rule/index.md @@ -0,0 +1,83 @@ +--- +title: rule +hide_title: false +hide_table_of_contents: false +keywords: + - rule + - 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 +--- +Gets an individual rule resource + +## Overview + + + + + +
Namerule
TypeResource
Descriptionrule
Idawscc.vpclattice.rule
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
actionobject
arnstring
idstring
listener_identifierstring
matchobject
namestring
priorityinteger
service_identifierstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule resource, the following permissions are required: + +### Read +
+vpc-lattice:GetRule,
+vpc-lattice:ListTagsForResource
+ +### Update +
+vpc-lattice:UpdateRule,
+vpc-lattice:GetRule,
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource
+ +### Delete +
+vpc-lattice:DeleteRule
+ + +## Example +```sql +SELECT +region, +action, +arn, +id, +listener_identifier, +match, +name, +priority, +service_identifier, +tags +FROM awscc.vpclattice.rule +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/rules/index.md b/docs/awscc-docs/providers/awscc/vpclattice/rules/index.md new file mode 100644 index 0000000000..fe0fb7a88d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/rules/index.md @@ -0,0 +1,61 @@ +--- +title: rules +hide_title: false +hide_table_of_contents: false +keywords: + - rules + - 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 +--- +Retrieves a list of rules in a region + +## Overview + + + + + +
Namerules
TypeResource
Descriptionrules
Idawscc.vpclattice.rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Create +
+vpc-lattice:CreateRule,
+vpc-lattice:GetRule,
+vpc-lattice:ListTagsForResource,
+vpc-lattice:TagResource
+ +### List +
+vpc-lattice:ListRules
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service/index.md new file mode 100644 index 0000000000..11f4a3d437 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/service/index.md @@ -0,0 +1,89 @@ +--- +title: service +hide_title: false +hide_table_of_contents: false +keywords: + - service + - 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 +--- +Gets an individual service resource + +## Overview + + + + + +
Nameservice
TypeResource
Descriptionservice
Idawscc.vpclattice.service
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
auth_typestring
created_atstring
dns_entryobject
idstring
last_updated_atstring
namestring
statusstring
certificate_arnstring
custom_domain_namestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +
+vpc-lattice:GetService,
+vpc-lattice:ListTagsForResource
+ +### Update +
+vpc-lattice:UpdateService,
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource,
+vpc-lattice:GetService,
+vpc-lattice:ListTagsForResource
+ +### Delete +
+vpc-lattice:DeleteService,
+vpc-lattice:GetService
+ + +## Example +```sql +SELECT +region, +arn, +auth_type, +created_at, +dns_entry, +id, +last_updated_at, +name, +status, +certificate_arn, +custom_domain_name, +tags +FROM awscc.vpclattice.service +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md new file mode 100644 index 0000000000..835dafd908 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md @@ -0,0 +1,79 @@ +--- +title: service_network +hide_title: false +hide_table_of_contents: false +keywords: + - service_network + - 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 +--- +Gets an individual service_network resource + +## Overview + + + + + +
Nameservice_network
TypeResource
Descriptionservice_network
Idawscc.vpclattice.service_network
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
created_atstring
idstring
last_updated_atstring
namestring
auth_typestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_network resource, the following permissions are required: + +### Read +
+vpc-lattice:GetServiceNetwork,
+vpc-lattice:ListTagsForResource
+ +### Update +
+vpc-lattice:GetServiceNetwork,
+vpc-lattice:UpdateServiceNetwork,
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource
+ +### Delete +
+vpc-lattice:DeleteServiceNetwork
+ + +## Example +```sql +SELECT +region, +arn, +created_at, +id, +last_updated_at, +name, +auth_type, +tags +FROM awscc.vpclattice.service_network +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_association/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_association/index.md new file mode 100644 index 0000000000..01f75fc251 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_association/index.md @@ -0,0 +1,94 @@ +--- +title: service_network_service_association +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_service_association + - 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 +--- +Gets an individual service_network_service_association resource + +## Overview + + + + + +
Nameservice_network_service_association
TypeResource
Descriptionservice_network_service_association
Idawscc.vpclattice.service_network_service_association
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
created_atstring
dns_entryobject
idstring
service_network_arnstring
service_network_idstring
service_network_identifierstring
service_network_namestring
service_arnstring
service_idstring
service_identifierstring
service_namestring
statusstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_network_service_association resource, the following permissions are required: + +### Read +
+vpc-lattice:GetServiceNetworkServiceAssociation,
+vpc-lattice:ListTagsForResource
+ +### Update +
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource,
+vpc-lattice:GetServiceNetworkServiceAssociation,
+vpc-lattice:ListTagsForResource
+ +### Delete +
+vpc-lattice:DeleteServiceNetworkServiceAssociation,
+vpc-lattice:GetServiceNetworkServiceAssociation
+ + +## Example +```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, +tags +FROM awscc.vpclattice.service_network_service_association +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_associations/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_associations/index.md new file mode 100644 index 0000000000..e4e0051bd8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_associations/index.md @@ -0,0 +1,61 @@ +--- +title: service_network_service_associations +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_service_associations + - 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 +--- +Retrieves a list of service_network_service_associations in a region + +## Overview + + + + + +
Nameservice_network_service_associations
TypeResource
Descriptionservice_network_service_associations
Idawscc.vpclattice.service_network_service_associations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_network_service_associations resource, the following permissions are required: + +### Create +
+vpc-lattice:CreateServiceNetworkServiceAssociation,
+vpc-lattice:GetServiceNetworkServiceAssociation,
+vpc-lattice:TagResource,
+vpc-lattice:ListTagsForResource
+ +### List +
+vpc-lattice:ListServiceNetworkServiceAssociations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.service_network_service_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_association/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_association/index.md new file mode 100644 index 0000000000..12a3b98937 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_association/index.md @@ -0,0 +1,92 @@ +--- +title: service_network_vpc_association +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_vpc_association + - 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 +--- +Gets an individual service_network_vpc_association resource + +## Overview + + + + + +
Nameservice_network_vpc_association
TypeResource
Descriptionservice_network_vpc_association
Idawscc.vpclattice.service_network_vpc_association
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
created_atstring
security_group_idsarray
idstring
service_network_arnstring
service_network_idstring
service_network_identifierstring
service_network_namestring
statusstring
vpc_idstring
vpc_identifierstring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_network_vpc_association resource, the following permissions are required: + +### Read +
+vpc-lattice:GetServiceNetworkVpcAssociation,
+vpc-lattice:ListTagsForResource
+ +### Update +
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource,
+vpc-lattice:GetServiceNetworkVpcAssociation,
+vpc-lattice:UpdateServiceNetworkVpcAssociation,
+ec2:DescribeSecurityGroups,
+vpc-lattice:ListTagsForResource
+ +### Delete +
+vpc-lattice:DeleteServiceNetworkVpcAssociation,
+vpc-lattice:GetServiceNetworkVpcAssociation
+ + +## Example +```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, +tags +FROM awscc.vpclattice.service_network_vpc_association +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_associations/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_associations/index.md new file mode 100644 index 0000000000..d85a67e393 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_associations/index.md @@ -0,0 +1,64 @@ +--- +title: service_network_vpc_associations +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_vpc_associations + - 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 +--- +Retrieves a list of service_network_vpc_associations in a region + +## Overview + + + + + +
Nameservice_network_vpc_associations
TypeResource
Descriptionservice_network_vpc_associations
Idawscc.vpclattice.service_network_vpc_associations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_network_vpc_associations resource, the following permissions are required: + +### Create +
+vpc-lattice:CreateServiceNetworkVpcAssociation,
+vpc-lattice:GetServiceNetworkVpcAssociation,
+vpc-lattice:ListServiceNetworkVpcAssociations,
+vpc-lattice:ListTagsForResource,
+ec2:DescribeSecurityGroups,
+ec2:DescribeVpcs,
+vpc-lattice:TagResource
+ +### List +
+vpc-lattice:ListServiceNetworkVpcAssociations
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.service_network_vpc_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md new file mode 100644 index 0000000000..1dee052577 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md @@ -0,0 +1,62 @@ +--- +title: service_networks +hide_title: false +hide_table_of_contents: false +keywords: + - service_networks + - 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 +--- +Retrieves a list of service_networks in a region + +## Overview + + + + + +
Nameservice_networks
TypeResource
Descriptionservice_networks
Idawscc.vpclattice.service_networks
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the service_networks resource, the following permissions are required: + +### Create +
+vpc-lattice:GetServiceNetwork,
+vpc-lattice:ListTagsForResource,
+vpc-lattice:CreateServiceNetwork,
+vpc-lattice:TagResource,
+iam:CreateServiceLinkedRole
+ +### List +
+vpc-lattice:ListServiceNetworks
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.service_networks +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/services/index.md b/docs/awscc-docs/providers/awscc/vpclattice/services/index.md new file mode 100644 index 0000000000..3ff42bdc28 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/services/index.md @@ -0,0 +1,64 @@ +--- +title: services +hide_title: false +hide_table_of_contents: false +keywords: + - services + - 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 +--- +Retrieves a list of services in a region + +## Overview + + + + + +
Nameservices
TypeResource
Descriptionservices
Idawscc.vpclattice.services
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +
+vpc-lattice:CreateService,
+vpc-lattice:GetService,
+vpc-lattice:ListTagsForResource,
+vpc-lattice:TagResource,
+acm:DescribeCertificate,
+acm:ListCertificates,
+iam:CreateServiceLinkedRole
+ +### List +
+vpc-lattice:ListServices
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.services +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md b/docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md new file mode 100644 index 0000000000..2c51a5d8ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md @@ -0,0 +1,102 @@ +--- +title: target_group +hide_title: false +hide_table_of_contents: false +keywords: + - target_group + - 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 +--- +Gets an individual target_group resource + +## Overview + + + + + +
Nametarget_group
TypeResource
Descriptiontarget_group
Idawscc.vpclattice.target_group
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
configobject
created_atstring
idstring
last_updated_atstring
namestring
statusstring
typestring
targetsarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the target_group resource, the following permissions are required: + +### Read +
+vpc-lattice:GetTargetGroup,
+vpc-lattice:ListTargets,
+vpc-lattice:ListTagsForResource
+ +### Update +
+vpc-lattice:UpdateTargetGroup,
+vpc-lattice:GetTargetGroup,
+vpc-lattice:ListTargets,
+vpc-lattice:RegisterTargets,
+vpc-lattice:DeregisterTargets,
+ec2:DescribeVpcs,
+ec2:DescribeInstances,
+ec2:DescribeSubnets,
+ec2:DescribeAvailabilityZoneMappings,
+elasticloadbalancing:DescribeLoadBalancers,
+lambda:Invoke,
+lambda:RemovePermission,
+lambda:AddPermission,
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource,
+vpc-lattice:ListTagsForResource
+ +### Delete +
+vpc-lattice:DeleteTargetGroup,
+vpc-lattice:GetTargetGroup,
+vpc-lattice:DeregisterTargets,
+vpc-lattice:ListTargets,
+lambda:RemovePermission
+ + +## Example +```sql +SELECT +region, +arn, +config, +created_at, +id, +last_updated_at, +name, +status, +type, +targets, +tags +FROM awscc.vpclattice.target_group +WHERE region = 'us-east-1' +AND data__Identifier = '<Arn>' +``` diff --git a/docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md b/docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md new file mode 100644 index 0000000000..da4d5ae31b --- /dev/null +++ b/docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md @@ -0,0 +1,72 @@ +--- +title: target_groups +hide_title: false +hide_table_of_contents: false +keywords: + - target_groups + - 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 +--- +Retrieves a list of target_groups in a region + +## Overview + + + + + +
Nametarget_groups
TypeResource
Descriptiontarget_groups
Idawscc.vpclattice.target_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the target_groups resource, the following permissions are required: + +### Create +
+vpc-lattice:CreateTargetGroup,
+vpc-lattice:GetTargetGroup,
+vpc-lattice:RegisterTargets,
+vpc-lattice:ListTargets,
+vpc-lattice:ListTagsForResource,
+vpc-lattice:TagResource,
+vpc-lattice:UntagResource,
+ec2:DescribeVpcs,
+ec2:DescribeInstances,
+ec2:DescribeSubnets,
+ec2:DescribeAvailabilityZoneMappings,
+lambda:Invoke,
+lambda:AddPermission,
+elasticloadbalancing:DescribeLoadBalancers,
+iam:CreateServiceLinkedRole
+ +### List +
+vpc-lattice:ListTargetGroups
+ + +## Example +```sql +SELECT +region, +arn +FROM awscc.vpclattice.target_groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/index.md b/docs/awscc-docs/providers/awscc/wafv2/index.md new file mode 100644 index 0000000000..5b83ad9236 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/index.md @@ -0,0 +1,49 @@ +--- +title: wafv2 +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The wafv2 service documentation. + +:::info Service Summary + +
+
+total resources: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+ip_set
+ip_sets
+logging_configuration
+logging_configurations
+regex_pattern_set
+regex_pattern_sets +
+
+rule_group
+rule_groups
+web_acl
+web_acls
+webacl_association
+webacl_associations +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/wafv2/ip_set/index.md b/docs/awscc-docs/providers/awscc/wafv2/ip_set/index.md new file mode 100644 index 0000000000..66f8276c8a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/ip_set/index.md @@ -0,0 +1,82 @@ +--- +title: ip_set +hide_title: false +hide_table_of_contents: false +keywords: + - ip_set + - 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 +--- +Gets an individual ip_set resource + +## Overview + + + + + +
Nameip_set
TypeResource
Descriptionip_set
Idawscc.wafv2.ip_set
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
descriptionstring
namestring
idstring
scopestring
i_paddress_versionstring
addressesarrayList of IPAddresses.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ip_set resource, the following permissions are required: + +### Delete +
+wafv2:DeleteIPSet,
+wafv2:GetIPSet
+ +### Read +
+wafv2:GetIPSet,
+wafv2:ListTagsForResource
+ +### Update +
+wafv2:UpdateIPSet,
+wafv2:GetIPSet,
+wafv2:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn, +description, +name, +id, +scope, +i_paddress_version, +addresses, +tags +FROM awscc.wafv2.ip_set +WHERE data__Identifier = '<Name>' +AND data__Identifier = '<Id>' +AND data__Identifier = '<Scope>' +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md b/docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md new file mode 100644 index 0000000000..642db03561 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md @@ -0,0 +1,64 @@ +--- +title: ip_sets +hide_title: false +hide_table_of_contents: false +keywords: + - ip_sets + - 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 +--- +Retrieves a list of ip_sets in a region + +## Overview + + + + + +
Nameip_sets
TypeResource
Descriptionip_sets
Idawscc.wafv2.ip_sets
+ +## Fields + + + + + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ip_sets resource, the following permissions are required: + +### Create +
+wafv2:CreateIPSet,
+wafv2:GetIPSet,
+wafv2:ListTagsForResource
+ +### List +
+wafv2:listIPSets
+ + +## Example +```sql +SELECT +region, +name, +id, +scope +FROM awscc.wafv2.ip_sets + +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md b/docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md new file mode 100644 index 0000000000..ed820fc5e8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md @@ -0,0 +1,82 @@ +--- +title: logging_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configuration + - 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 +--- +Gets an individual logging_configuration resource + +## Overview + + + + + +
Namelogging_configuration
TypeResource
Descriptionlogging_configuration
Idawscc.wafv2.logging_configuration
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
resource_arnstringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
log_destination_configsarrayThe Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.
redacted_fieldsarrayThe 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.
managed_by_firewall_managerbooleanIndicates 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.
logging_filterobjectFiltering 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.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the logging_configuration resource, the following permissions are required: + +### Read +
+wafv2:GetLoggingConfiguration
+ +### Update +
+wafv2:PutLoggingConfiguration,
+wafv2:GetLoggingConfiguration,
+firehose:ListDeliveryStreams,
+iam:CreateServiceLinkedRole,
+iam:DescribeOrganization,
+logs:CreateLogDelivery,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups
+ +### Delete +
+wafv2:DeleteLoggingConfiguration,
+wafv2:GetLoggingConfiguration,
+logs:DeleteLogDelivery
+ + +## Example +```sql +SELECT +region, +resource_arn, +log_destination_configs, +redacted_fields, +managed_by_firewall_manager, +logging_filter +FROM awscc.wafv2.logging_configuration +WHERE data__Identifier = '<ResourceArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md b/docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md new file mode 100644 index 0000000000..ab813084a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md @@ -0,0 +1,68 @@ +--- +title: logging_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations + - 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 +--- +Retrieves a list of logging_configurations in a region + +## Overview + + + + + +
Namelogging_configurations
TypeResource
Descriptionlogging_configurations
Idawscc.wafv2.logging_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
resource_arnstringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the logging_configurations resource, the following permissions are required: + +### Create +
+wafv2:PutLoggingConfiguration,
+wafv2:GetLoggingConfiguration,
+firehose:ListDeliveryStreams,
+iam:CreateServiceLinkedRole,
+iam:DescribeOrganization,
+logs:CreateLogDelivery,
+s3:PutBucketPolicy,
+s3:GetBucketPolicy,
+logs:PutResourcePolicy,
+logs:DescribeResourcePolicies,
+logs:DescribeLogGroups
+ +### List +
+wafv2:ListLoggingConfigurations
+ + +## Example +```sql +SELECT +region, +resource_arn +FROM awscc.wafv2.logging_configurations + +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_set/index.md b/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_set/index.md new file mode 100644 index 0000000000..f9c52fc157 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_set/index.md @@ -0,0 +1,80 @@ +--- +title: regex_pattern_set +hide_title: false +hide_table_of_contents: false +keywords: + - regex_pattern_set + - 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 +--- +Gets an individual regex_pattern_set resource + +## Overview + + + + + +
Nameregex_pattern_set
TypeResource
Descriptionregex_pattern_set
Idawscc.wafv2.regex_pattern_set
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstringARN of the WAF entity.
descriptionstringDescription of the entity.
namestringName of the RegexPatternSet.
idstringId of the RegexPatternSet
regular_expression_listarray
scopestringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the regex_pattern_set resource, the following permissions are required: + +### Delete +
+wafv2:DeleteRegexPatternSet,
+wafv2:GetRegexPatternSet
+ +### Read +
+wafv2:GetRegexPatternSet,
+wafv2:ListTagsForResource
+ +### Update +
+wafv2:UpdateRegexPatternSet,
+wafv2:GetRegexPatternSet,
+wafv2:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn, +description, +name, +id, +regular_expression_list, +scope, +tags +FROM awscc.wafv2.regex_pattern_set +WHERE data__Identifier = '<Name>' +AND data__Identifier = '<Id>' +AND data__Identifier = '<Scope>' +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_sets/index.md b/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_sets/index.md new file mode 100644 index 0000000000..c4adc7b281 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_sets/index.md @@ -0,0 +1,64 @@ +--- +title: regex_pattern_sets +hide_title: false +hide_table_of_contents: false +keywords: + - regex_pattern_sets + - 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 +--- +Retrieves a list of regex_pattern_sets in a region + +## Overview + + + + + +
Nameregex_pattern_sets
TypeResource
Descriptionregex_pattern_sets
Idawscc.wafv2.regex_pattern_sets
+ +## Fields + + + + + + + +
NameDatatypeDescription
namestringName of the RegexPatternSet.
idstringId of the RegexPatternSet
scopestringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the regex_pattern_sets resource, the following permissions are required: + +### Create +
+wafv2:CreateRegexPatternSet,
+wafv2:GetRegexPatternSet,
+wafv2:ListTagsForResource
+ +### List +
+wafv2:listRegexPatternSets
+ + +## Example +```sql +SELECT +region, +name, +id, +scope +FROM awscc.wafv2.regex_pattern_sets + +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md b/docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md new file mode 100644 index 0000000000..d42ad7f5ac --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md @@ -0,0 +1,92 @@ +--- +title: rule_group +hide_title: false +hide_table_of_contents: false +keywords: + - rule_group + - 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 +--- +Gets an individual rule_group resource + +## Overview + + + + + +
Namerule_group
TypeResource
Descriptionrule_group
Idawscc.wafv2.rule_group
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
capacityinteger
descriptionstring
namestring
idstring
scopestring
rulesarrayCollection of Rules.
visibility_configobject
tagsarray
label_namespacestring
custom_response_bodiesobject
available_labelsarrayCollection of Available Labels.
consumed_labelsarrayCollection of Consumed Labels.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule_group resource, the following permissions are required: + +### Delete +
+wafv2:DeleteRuleGroup,
+wafv2:GetRuleGroup
+ +### Read +
+wafv2:GetRuleGroup,
+wafv2:ListTagsForResource
+ +### Update +
+wafv2:UpdateRuleGroup,
+wafv2:GetRuleGroup,
+wafv2:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn, +capacity, +description, +name, +id, +scope, +rules, +visibility_config, +tags, +label_namespace, +custom_response_bodies, +available_labels, +consumed_labels +FROM awscc.wafv2.rule_group +WHERE data__Identifier = '<Name>' +AND data__Identifier = '<Id>' +AND data__Identifier = '<Scope>' +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md b/docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md new file mode 100644 index 0000000000..d426d332d8 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md @@ -0,0 +1,64 @@ +--- +title: rule_groups +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups + - 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 +--- +Retrieves a list of rule_groups in a region + +## Overview + + + + + +
Namerule_groups
TypeResource
Descriptionrule_groups
Idawscc.wafv2.rule_groups
+ +## Fields + + + + + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the rule_groups resource, the following permissions are required: + +### Create +
+wafv2:CreateRuleGroup,
+wafv2:GetRuleGroup,
+wafv2:ListTagsForResource
+ +### List +
+wafv2:listRuleGroups
+ + +## Example +```sql +SELECT +region, +name, +id, +scope +FROM awscc.wafv2.rule_groups + +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md b/docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md new file mode 100644 index 0000000000..3f3ba984be --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md @@ -0,0 +1,98 @@ +--- +title: web_acl +hide_title: false +hide_table_of_contents: false +keywords: + - web_acl + - 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 +--- +Gets an individual web_acl resource + +## Overview + + + + + +
Nameweb_acl
TypeResource
Descriptionweb_acl
Idawscc.wafv2.web_acl
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
capacityinteger
default_actionobject
descriptionstring
namestring
idstring
scopestring
rulesarrayCollection of Rules.
visibility_configobject
tagsarray
label_namespacestring
custom_response_bodiesobject
captcha_configobject
challenge_configobject
token_domainsarray
association_configobject
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the web_acl resource, the following permissions are required: + +### Delete +
+wafv2:DeleteWebACL,
+wafv2:GetWebACL
+ +### Read +
+wafv2:GetWebACL,
+wafv2:ListTagsForResource
+ +### Update +
+wafv2:UpdateWebACL,
+wafv2:GetWebACL,
+wafv2:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +arn, +capacity, +default_action, +description, +name, +id, +scope, +rules, +visibility_config, +tags, +label_namespace, +custom_response_bodies, +captcha_config, +challenge_config, +token_domains, +association_config +FROM awscc.wafv2.web_acl +WHERE data__Identifier = '<Name>' +AND data__Identifier = '<Id>' +AND data__Identifier = '<Scope>' +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md b/docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md new file mode 100644 index 0000000000..2794894775 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md @@ -0,0 +1,64 @@ +--- +title: web_acls +hide_title: false +hide_table_of_contents: false +keywords: + - web_acls + - 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 +--- +Retrieves a list of web_acls in a region + +## Overview + + + + + +
Nameweb_acls
TypeResource
Descriptionweb_acls
Idawscc.wafv2.web_acls
+ +## Fields + + + + + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the web_acls resource, the following permissions are required: + +### Create +
+wafv2:CreateWebACL,
+wafv2:GetWebACL,
+wafv2:ListTagsForResource
+ +### List +
+wafv2:listWebACLs
+ + +## Example +```sql +SELECT +region, +name, +id, +scope +FROM awscc.wafv2.web_acls + +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md b/docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md new file mode 100644 index 0000000000..cdd748aadd --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md @@ -0,0 +1,113 @@ +--- +title: webacl_association +hide_title: false +hide_table_of_contents: false +keywords: + - webacl_association + - 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 +--- +Gets an individual webacl_association resource + +## Overview + + + + + +
Namewebacl_association
TypeResource
Descriptionwebacl_association
Idawscc.wafv2.webacl_association
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_arnstring
web_ac_larnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the webacl_association resource, the following permissions are required: + +### Delete +
+wafv2:AssociateWebACL,
+wafv2:GetWebACLForResource,
+wafv2:GetWebACL,
+wafv2:DisassociateWebACL,
+elasticloadbalancing:SetWebACL,
+apigateway:SetWebACL,
+appsync:SetWebACL,
+cognito-idp:AssociateWebACL,
+cognito-idp:DisassociateWebACL,
+cognito-idp:GetWebACLForResource,
+apprunner:AssociateWebAcl,
+apprunner:DisassociateWebAcl,
+apprunner:DescribeWebAclForService,
+ec2:AssociateVerifiedAccessInstanceWebAcl,
+ec2:DisassociateVerifiedAccessInstanceWebAcl,
+ec2:DescribeVerifiedAccessInstanceWebAclAssociations,
+ec2:GetVerifiedAccessInstanceWebAcl
+ +### Read +
+wafv2:AssociateWebACL,
+wafv2:GetWebACLForResource,
+wafv2:GetWebACL,
+wafv2:DisassociateWebACL,
+elasticloadbalancing:SetWebACL,
+apigateway:SetWebACL,
+appsync:SetWebACL,
+cognito-idp:AssociateWebACL,
+cognito-idp:DisassociateWebACL,
+cognito-idp:GetWebACLForResource,
+apprunner:AssociateWebAcl,
+apprunner:DisassociateWebAcl,
+apprunner:DescribeWebAclForService,
+ec2:AssociateVerifiedAccessInstanceWebAcl,
+ec2:DisassociateVerifiedAccessInstanceWebAcl,
+ec2:DescribeVerifiedAccessInstanceWebAclAssociations,
+ec2:GetVerifiedAccessInstanceWebAcl
+ +### Update +
+wafv2:AssociateWebACL,
+wafv2:GetWebACLForResource,
+wafv2:GetWebACL,
+wafv2:DisassociateWebACL,
+elasticloadbalancing:SetWebACL,
+apigateway:SetWebACL,
+appsync:SetWebACL,
+cognito-idp:AssociateWebACL,
+cognito-idp:DisassociateWebACL,
+cognito-idp:GetWebACLForResource,
+apprunner:AssociateWebAcl,
+apprunner:DisassociateWebAcl,
+apprunner:DescribeWebAclForService,
+ec2:AssociateVerifiedAccessInstanceWebAcl,
+ec2:DisassociateVerifiedAccessInstanceWebAcl,
+ec2:DescribeVerifiedAccessInstanceWebAclAssociations,
+ec2:GetVerifiedAccessInstanceWebAcl
+ + +## Example +```sql +SELECT +region, +resource_arn, +web_ac_larn +FROM awscc.wafv2.webacl_association +WHERE data__Identifier = '<ResourceArn>' +AND data__Identifier = '<WebACLArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/wafv2/webacl_associations/index.md b/docs/awscc-docs/providers/awscc/wafv2/webacl_associations/index.md new file mode 100644 index 0000000000..b07d17c08d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wafv2/webacl_associations/index.md @@ -0,0 +1,72 @@ +--- +title: webacl_associations +hide_title: false +hide_table_of_contents: false +keywords: + - webacl_associations + - 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 +--- +Retrieves a list of webacl_associations in a region + +## Overview + + + + + +
Namewebacl_associations
TypeResource
Descriptionwebacl_associations
Idawscc.wafv2.webacl_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_arnundefined
web_ac_larnundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the webacl_associations resource, the following permissions are required: + +### Create +
+wafv2:AssociateWebACL,
+wafv2:GetWebACLForResource,
+wafv2:GetWebACL,
+wafv2:DisassociateWebACL,
+elasticloadbalancing:SetWebACL,
+apigateway:SetWebACL,
+appsync:SetWebACL,
+cognito-idp:AssociateWebACL,
+cognito-idp:DisassociateWebACL,
+cognito-idp:GetWebACLForResource,
+apprunner:AssociateWebAcl,
+apprunner:DisassociateWebAcl,
+apprunner:DescribeWebAclForService,
+ec2:AssociateVerifiedAccessInstanceWebAcl,
+ec2:DisassociateVerifiedAccessInstanceWebAcl,
+ec2:DescribeVerifiedAccessInstanceWebAclAssociations,
+ec2:GetVerifiedAccessInstanceWebAcl
+ + +## Example +```sql +SELECT +region, +resource_arn, +web_ac_larn +FROM awscc.wafv2.webacl_associations + +``` diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistant/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistant/index.md new file mode 100644 index 0000000000..42905412ce --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wisdom/assistant/index.md @@ -0,0 +1,75 @@ +--- +title: assistant +hide_title: false +hide_table_of_contents: false +keywords: + - assistant + - 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 +--- +Gets an individual assistant resource + +## Overview + + + + + +
Nameassistant
TypeResource
Descriptionassistant
Idawscc.wisdom.assistant
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
typestring
descriptionstring
assistant_arnstring
assistant_idstring
server_side_encryption_configurationobject
tagsarray
namestring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assistant resource, the following permissions are required: + +### Update +
+wisdom:GetAssistant
+ +### Read +
+wisdom:GetAssistant
+ +### Delete +
+wisdom:DeleteAssistant
+ + +## Example +```sql +SELECT +region, +type, +description, +assistant_arn, +assistant_id, +server_side_encryption_configuration, +tags, +name +FROM awscc.wisdom.assistant +WHERE region = 'us-east-1' +AND data__Identifier = '<AssistantId>' +``` diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md new file mode 100644 index 0000000000..f535b994af --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md @@ -0,0 +1,76 @@ +--- +title: assistant_association +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_association + - 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 +--- +Gets an individual assistant_association resource + +## Overview + + + + + +
Nameassistant_association
TypeResource
Descriptionassistant_association
Idawscc.wisdom.assistant_association
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
assistant_association_arnstring
assistant_arnstring
assistant_association_idstring
assistant_idstring
associationobject
association_typestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assistant_association resource, the following permissions are required: + +### Update +
+wisdom:GetAssistantAssociation
+ +### Read +
+wisdom:GetAssistantAssociation
+ +### Delete +
+wisdom:DeleteAssistantAssociation
+ + +## Example +```sql +SELECT +region, +assistant_association_arn, +assistant_arn, +assistant_association_id, +assistant_id, +association, +association_type, +tags +FROM awscc.wisdom.assistant_association +WHERE region = 'us-east-1' +AND data__Identifier = '<AssistantAssociationId>' +AND data__Identifier = '<AssistantId>' +``` diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md new file mode 100644 index 0000000000..323f56a8a6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md @@ -0,0 +1,61 @@ +--- +title: assistant_associations +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_associations + - 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 +--- +Retrieves a list of assistant_associations in a region + +## Overview + + + + + +
Nameassistant_associations
TypeResource
Descriptionassistant_associations
Idawscc.wisdom.assistant_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
assistant_association_idstring
assistant_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assistant_associations resource, the following permissions are required: + +### Create +
+wisdom:CreateAssistantAssociation,
+wisdom:TagResource
+ +### List +
+wisdom:ListAssistantAssociations
+ + +## Example +```sql +SELECT +region, +assistant_association_id, +assistant_id +FROM awscc.wisdom.assistant_associations +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistants/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistants/index.md new file mode 100644 index 0000000000..d1044083da --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wisdom/assistants/index.md @@ -0,0 +1,61 @@ +--- +title: assistants +hide_title: false +hide_table_of_contents: false +keywords: + - assistants + - 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 +--- +Retrieves a list of assistants in a region + +## Overview + + + + + +
Nameassistants
TypeResource
Descriptionassistants
Idawscc.wisdom.assistants
+ +## Fields + + + + + +
NameDatatypeDescription
assistant_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the assistants resource, the following permissions are required: + +### Create +
+kms:CreateGrant,
+kms:DescribeKey,
+wisdom:CreateAssistant,
+wisdom:TagResource
+ +### List +
+wisdom:ListAssistants
+ + +## Example +```sql +SELECT +region, +assistant_id +FROM awscc.wisdom.assistants +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/wisdom/index.md b/docs/awscc-docs/providers/awscc/wisdom/index.md new file mode 100644 index 0000000000..6ece5e265c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wisdom/index.md @@ -0,0 +1,43 @@ +--- +title: wisdom +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The wisdom service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+assistant
+assistant_association
+assistant_associations +
+
+assistants
+knowledge_base
+knowledge_bases +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/wisdom/knowledge_base/index.md b/docs/awscc-docs/providers/awscc/wisdom/knowledge_base/index.md new file mode 100644 index 0000000000..e9af6d9643 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wisdom/knowledge_base/index.md @@ -0,0 +1,82 @@ +--- +title: knowledge_base +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_base + - 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 +--- +Gets an individual knowledge_base resource + +## Overview + + + + + +
Nameknowledge_base
TypeResource
Descriptionknowledge_base
Idawscc.wisdom.knowledge_base
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring
knowledge_base_arnstring
knowledge_base_idstring
knowledge_base_typestring
namestring
rendering_configurationobject
server_side_encryption_configurationobject
source_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the knowledge_base resource, the following permissions are required: + +### Update +
+wisdom:GetKnowledgeBase
+ +### Delete +
+appflow:DeleteFlow,
+appflow:StopFlow,
+app-integrations:DeleteDataIntegrationAssociation,
+wisdom:DeleteKnowledgeBase
+ +### Read +
+wisdom:GetKnowledgeBase
+ + +## Example +```sql +SELECT +region, +description, +knowledge_base_arn, +knowledge_base_id, +knowledge_base_type, +name, +rendering_configuration, +server_side_encryption_configuration, +source_configuration, +tags +FROM awscc.wisdom.knowledge_base +WHERE region = 'us-east-1' +AND data__Identifier = '<KnowledgeBaseId>' +``` diff --git a/docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md b/docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md new file mode 100644 index 0000000000..a1a7e176f1 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md @@ -0,0 +1,69 @@ +--- +title: knowledge_bases +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_bases + - 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 +--- +Retrieves a list of knowledge_bases in a region + +## Overview + + + + + +
Nameknowledge_bases
TypeResource
Descriptionknowledge_bases
Idawscc.wisdom.knowledge_bases
+ +## Fields + + + + + +
NameDatatypeDescription
knowledge_base_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the knowledge_bases resource, the following permissions are required: + +### Create +
+appflow:CreateFlow,
+appflow:DeleteFlow,
+appflow:StartFlow,
+appflow:TagResource,
+appflow:UseConnectorProfile,
+app-integrations:CreateDataIntegrationAssociation,
+app-integrations:GetDataIntegration,
+kms:DescribeKey,
+kms:CreateGrant,
+kms:ListGrants,
+wisdom:CreateKnowledgeBase,
+wisdom:TagResource
+ +### List +
+wisdom:ListKnowledgeBases
+ + +## Example +```sql +SELECT +region, +knowledge_base_id +FROM awscc.wisdom.knowledge_bases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md b/docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md new file mode 100644 index 0000000000..7caeda6a89 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md @@ -0,0 +1,67 @@ +--- +title: connection_alias +hide_title: false +hide_table_of_contents: false +keywords: + - connection_alias + - workspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual connection_alias resource + +## Overview + + + + + +
Nameconnection_alias
TypeResource
Descriptionconnection_alias
Idawscc.workspaces.connection_alias
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
associationsarray
alias_idstring
connection_stringstring
connection_alias_statestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connection_alias resource, the following permissions are required: + +### Read +
+workspaces:DescribeConnectionAliases
+ +### Delete +
+workspaces:DeleteConnectionAlias
+ + +## Example +```sql +SELECT +region, +associations, +alias_id, +connection_string, +connection_alias_state, +tags +FROM awscc.workspaces.connection_alias +WHERE region = 'us-east-1' +AND data__Identifier = '<AliasId>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspaces/connection_aliases/index.md b/docs/awscc-docs/providers/awscc/workspaces/connection_aliases/index.md new file mode 100644 index 0000000000..e18068c6af --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspaces/connection_aliases/index.md @@ -0,0 +1,54 @@ +--- +title: connection_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - connection_aliases + - workspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of connection_aliases in a region + +## Overview + + + + + +
Nameconnection_aliases
TypeResource
Descriptionconnection_aliases
Idawscc.workspaces.connection_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
alias_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the connection_aliases resource, the following permissions are required: + +### Create +
+workspaces:CreateConnectionAlias
+ + +## Example +```sql +SELECT +region, +alias_id +FROM awscc.workspaces.connection_aliases +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/workspaces/index.md b/docs/awscc-docs/providers/awscc/workspaces/index.md new file mode 100644 index 0000000000..0d55a1647d --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspaces/index.md @@ -0,0 +1,39 @@ +--- +title: workspaces +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The workspaces service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+connection_alias +
+
+connection_aliases +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/workspacesthinclient/environment/index.md b/docs/awscc-docs/providers/awscc/workspacesthinclient/environment/index.md new file mode 100644 index 0000000000..73d207a0cb --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesthinclient/environment/index.md @@ -0,0 +1,119 @@ +--- +title: environment +hide_title: false +hide_table_of_contents: false +keywords: + - environment + - 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 +--- +Gets an individual environment resource + +## Overview + + + + + +
Nameenvironment
TypeResource
Descriptionenvironment
Idawscc.workspacesthinclient.environment
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringUnique identifier of the environment.
namestringThe name of the environment.
desktop_arnstringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
desktop_endpointstringThe URL for the identity provider login (only for environments that use AppStream 2.0).
desktop_typestringThe type of VDI.
activation_codestringActivation code for devices associated with environment.
registered_devices_countintegerNumber of devices registered to the environment.
software_set_update_schedulestringAn option to define if software updates should be applied within a maintenance window.
maintenance_windowobjectA specification for a time window to apply software updates.
software_set_update_modestringAn option to define which software updates to apply.
desired_software_set_idstringThe ID of the software set to apply.
pending_software_set_idstringThe ID of the software set that is pending to be installed.
pending_software_set_versionstringThe version of the software set that is pending to be installed.
software_set_compliance_statusstringDescribes if the software currently installed on all devices in the environment is a supported version.
created_atstringThe timestamp in unix epoch format when environment was created.
updated_atstringThe timestamp in unix epoch format when environment was last updated.
arnstringThe environment ARN.
kms_key_arnstringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +
+thinclient:GetEnvironment,
+thinclient:ListTagsForResource,
+kms:DescribeKey,
+kms:Encrypt,
+kms:Decrypt
+ +### Update +
+appstream:DescribeStacks,
+workspaces:DescribeWorkspaceDirectories,
+workspaces-web:GetPortal,
+workspaces-web:GetUserSettings,
+thinclient:UpdateEnvironment,
+thinclient:GetEnvironment,
+thinclient:TagResource,
+thinclient:UntagResource,
+thinclient:ListTagsForResource,
+kms:DescribeKey,
+kms:Encrypt,
+kms:Decrypt,
+kms:CreateGrant,
+kms:RetireGrant
+ +### Delete +
+thinclient:DeleteEnvironment,
+thinclient:UntagResource,
+kms:DescribeKey,
+kms:RetireGrant
+ + +## Example +```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, +tags +FROM awscc.workspacesthinclient.environment +WHERE region = 'us-east-1' +AND data__Identifier = '<Id>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md b/docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md new file mode 100644 index 0000000000..7872ff7ca2 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md @@ -0,0 +1,72 @@ +--- +title: environments +hide_title: false +hide_table_of_contents: false +keywords: + - environments + - 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 +--- +Retrieves a list of environments in a region + +## Overview + + + + + +
Nameenvironments
TypeResource
Descriptionenvironments
Idawscc.workspacesthinclient.environments
+ +## Fields + + + + + +
NameDatatypeDescription
idstringUnique identifier of the environment.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +
+thinclient:CreateEnvironment,
+thinclient:TagResource,
+thinclient:ListTagsForResource,
+appstream:DescribeStacks,
+workspaces:DescribeWorkspaceDirectories,
+workspaces-web:GetPortal,
+workspaces-web:GetUserSettings,
+kms:DescribeKey,
+kms:Encrypt,
+kms:Decrypt,
+kms:CreateGrant
+ +### List +
+thinclient:ListEnvironment,
+thinclient:ListTagsForResource,
+kms:DescribeKey,
+kms:Encrypt,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +id +FROM awscc.workspacesthinclient.environments +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesthinclient/index.md b/docs/awscc-docs/providers/awscc/workspacesthinclient/index.md new file mode 100644 index 0000000000..edab35d048 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesthinclient/index.md @@ -0,0 +1,39 @@ +--- +title: workspacesthinclient +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The workspacesthinclient service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+environment +
+
+environments +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/browser_settings/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/browser_settings/index.md new file mode 100644 index 0000000000..80cee016df --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/browser_settings/index.md @@ -0,0 +1,93 @@ +--- +title: browser_settings +hide_title: false +hide_table_of_contents: false +keywords: + - browser_settings + - 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 +--- +Gets an individual browser_settings resource + +## Overview + + + + + +
Namebrowser_settings
TypeResource
Descriptionbrowser_settings
Idawscc.workspacesweb.browser_settings
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
associated_portal_arnsarray
browser_policystring
browser_settings_arnstring
customer_managed_keystring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the browser_settings resource, the following permissions are required: + +### Read +
+workspaces-web:GetBrowserSettings,
+workspaces-web:ListBrowserSettings,
+workspaces-web:ListTagsForResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ +### Update +
+workspaces-web:UpdateBrowserSettings,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+workspaces-web:GetBrowserSettings,
+workspaces-web:ListBrowserSettings,
+workspaces-web:ListTagsForResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ +### Delete +
+workspaces-web:GetBrowserSettings,
+workspaces-web:DeleteBrowserSettings,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +browser_policy, +browser_settings_arn, +customer_managed_key, +tags +FROM awscc.workspacesweb.browser_settings +WHERE region = 'us-east-1' +AND data__Identifier = '<BrowserSettingsArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md new file mode 100644 index 0000000000..1d61c0efbf --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md @@ -0,0 +1,79 @@ +--- +title: identity_provider +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider + - 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 +--- +Gets an individual identity_provider resource + +## Overview + + + + + +
Nameidentity_provider
TypeResource
Descriptionidentity_provider
Idawscc.workspacesweb.identity_provider
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
identity_provider_arnstring
identity_provider_detailsobject
identity_provider_namestring
identity_provider_typestring
portal_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_provider resource, the following permissions are required: + +### Read +
+workspaces-web:GetIdentityProvider,
+workspaces-web:ListIdentityProviders,
+workspaces-web:ListTagsForResource
+ +### Update +
+workspaces-web:UpdateIdentityProvider,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+workspaces-web:GetIdentityProvider,
+workspaces-web:ListIdentityProviders,
+workspaces-web:ListTagsForResource
+ +### Delete +
+workspaces-web:GetIdentityProvider,
+workspaces-web:DeleteIdentityProvider
+ + +## Example +```sql +SELECT +region, +identity_provider_arn, +identity_provider_details, +identity_provider_name, +identity_provider_type, +portal_arn +FROM awscc.workspacesweb.identity_provider +WHERE region = 'us-east-1' +AND data__Identifier = '<IdentityProviderArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md new file mode 100644 index 0000000000..042960f413 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md @@ -0,0 +1,61 @@ +--- +title: identity_providers +hide_title: false +hide_table_of_contents: false +keywords: + - identity_providers + - 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 +--- +Retrieves a list of identity_providers in a region + +## Overview + + + + + +
Nameidentity_providers
TypeResource
Descriptionidentity_providers
Idawscc.workspacesweb.identity_providers
+ +## Fields + + + + + +
NameDatatypeDescription
identity_provider_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the identity_providers resource, the following permissions are required: + +### Create +
+workspaces-web:CreateIdentityProvider,
+workspaces-web:GetIdentityProvider,
+workspaces-web:ListTagsForResource,
+workspaces-web:TagResource
+ +### List +
+workspaces-web:ListIdentityProviders
+ + +## Example +```sql +SELECT +region, +identity_provider_arn +FROM awscc.workspacesweb.identity_providers +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/index.md new file mode 100644 index 0000000000..cc3d5eab34 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/index.md @@ -0,0 +1,48 @@ +--- +title: workspacesweb +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The workspacesweb service documentation. + +:::info Service Summary + +
+
+total resources: 11
+total selectable resources: 11
+total methods: 11
+
+
+ +::: + +## Resources +
+
+browser_settings
+identity_provider
+identity_providers
+ip_access_settings
+network_settings
+portal +
+
+portals
+trust_store
+trust_stores
+user_access_logging_settings
+user_settings +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/ip_access_settings/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/ip_access_settings/index.md new file mode 100644 index 0000000000..8f58813aa0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/ip_access_settings/index.md @@ -0,0 +1,100 @@ +--- +title: ip_access_settings +hide_title: false +hide_table_of_contents: false +keywords: + - ip_access_settings + - 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 +--- +Gets an individual ip_access_settings resource + +## Overview + + + + + +
Nameip_access_settings
TypeResource
Descriptionip_access_settings
Idawscc.workspacesweb.ip_access_settings
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
associated_portal_arnsarray
creation_datestring
customer_managed_keystring
descriptionstring
display_namestring
ip_access_settings_arnstring
ip_rulesarray
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the ip_access_settings resource, the following permissions are required: + +### Read +
+workspaces-web:GetIpAccessSettings,
+workspaces-web:ListIpAccessSettings,
+workspaces-web:ListTagsForResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ +### Update +
+workspaces-web:UpdateIpAccessSettings,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+workspaces-web:GetIpAccessSettings,
+workspaces-web:ListIpAccessSettings,
+workspaces-web:ListTagsForResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ +### Delete +
+workspaces-web:GetIpAccessSettings,
+workspaces-web:ListIpAccessSettings,
+workspaces-web:DeleteIpAccessSettings,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +description, +display_name, +ip_access_settings_arn, +ip_rules, +tags +FROM awscc.workspacesweb.ip_access_settings +WHERE region = 'us-east-1' +AND data__Identifier = '<IpAccessSettingsArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md new file mode 100644 index 0000000000..aa7aeb47a3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md @@ -0,0 +1,80 @@ +--- +title: network_settings +hide_title: false +hide_table_of_contents: false +keywords: + - network_settings + - 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 +--- +Gets an individual network_settings resource + +## Overview + + + + + +
Namenetwork_settings
TypeResource
Descriptionnetwork_settings
Idawscc.workspacesweb.network_settings
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
associated_portal_arnsarray
network_settings_arnstring
security_group_idsarray
subnet_idsarray
tagsarray
vpc_idstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the network_settings resource, the following permissions are required: + +### Read +
+workspaces-web:GetNetworkSettings,
+workspaces-web:ListTagsForResource
+ +### Update +
+workspaces-web:UpdateNetworkSettings,
+workspaces-web:UpdateResource,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+workspaces-web:GetNetworkSettings,
+workspaces-web:ListTagsForResource
+ +### Delete +
+workspaces-web:GetNetworkSettings,
+workspaces-web:DeleteNetworkSettings
+ + +## Example +```sql +SELECT +region, +associated_portal_arns, +network_settings_arn, +security_group_ids, +subnet_ids, +tags, +vpc_id +FROM awscc.workspacesweb.network_settings +WHERE region = 'us-east-1' +AND data__Identifier = '<NetworkSettingsArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md new file mode 100644 index 0000000000..f134d0dcd6 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md @@ -0,0 +1,145 @@ +--- +title: portal +hide_title: false +hide_table_of_contents: false +keywords: + - portal + - 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 +--- +Gets an individual portal resource + +## Overview + + + + + +
Nameportal
TypeResource
Descriptionportal
Idawscc.workspacesweb.portal
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
authentication_typestring
browser_settings_arnstring
browser_typestring
creation_datestring
customer_managed_keystring
display_namestring
ip_access_settings_arnstring
network_settings_arnstring
portal_arnstring
portal_endpointstring
portal_statusstring
renderer_typestring
service_provider_saml_metadatastring
status_reasonstring
tagsarray
trust_store_arnstring
user_access_logging_settings_arnstring
user_settings_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the portal resource, the following permissions are required: + +### Read +
+workspaces-web:GetPortal,
+workspaces-web:GetPortalServiceProviderMetadata,
+workspaces-web:ListTagsForResource,
+kms:Decrypt
+ +### Update +
+workspaces-web:GetPortal,
+workspaces-web:GetPortalServiceProviderMetadata,
+workspaces-web:UpdatePortal,
+workspaces-web:AssociateBrowserSettings,
+workspaces-web:AssociateIpAccessSettings,
+workspaces-web:AssociateNetworkSettings,
+workspaces-web:AssociateTrustStore,
+workspaces-web:AssociateUserAccessLoggingSettings,
+workspaces-web:AssociateUserSettings,
+workspaces-web:DisassociateBrowserSettings,
+workspaces-web:DisassociateIpAccessSettings,
+workspaces-web:DisassociateNetworkSettings,
+workspaces-web:DisassociateTrustStore,
+workspaces-web:DisassociateUserAccessLoggingSettings,
+workspaces-web:DisassociateUserSettings,
+workspaces-web:ListTagsForResource,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+kms:CreateGrant,
+kms:Encrypt,
+kms:GenerateDataKey,
+kms:Decrypt,
+ec2:CreateNetworkInterface,
+ec2:CreateNetworkInterfacePermission,
+ec2:DeleteNetworkInterface,
+ec2:DeleteNetworkInterfacePermission,
+ec2:ModifyNetworkInterfaceAttribute,
+kinesis:PutRecord,
+kinesis:PutRecords,
+kinesis:DescribeStreamSummary,
+sso:CreateManagedApplicationInstance,
+sso:DeleteManagedApplicationInstance,
+sso:DescribeRegisteredRegions,
+sso:GetApplicationInstance,
+sso:ListApplicationInstances
+ +### Delete +
+workspaces-web:GetPortal,
+workspaces-web:DeletePortal,
+workspaces-web:DisassociateBrowserSettings,
+workspaces-web:DisassociateIpAccessSettings,
+workspaces-web:DisassociateNetworkSettings,
+workspaces-web:DisassociateTrustStore,
+workspaces-web:DisassociateUserAccessLoggingSettings,
+workspaces-web:DisassociateUserSettings,
+kms:Decrypt,
+sso:DeleteManagedApplicationInstance
+ + +## Example +```sql +SELECT +region, +additional_encryption_context, +authentication_type, +browser_settings_arn, +browser_type, +creation_date, +customer_managed_key, +display_name, +ip_access_settings_arn, +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 awscc.workspacesweb.portal +WHERE region = 'us-east-1' +AND data__Identifier = '<PortalArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md new file mode 100644 index 0000000000..0cc93640af --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md @@ -0,0 +1,82 @@ +--- +title: portals +hide_title: false +hide_table_of_contents: false +keywords: + - portals + - 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 +--- +Retrieves a list of portals in a region + +## Overview + + + + + +
Nameportals
TypeResource
Descriptionportals
Idawscc.workspacesweb.portals
+ +## Fields + + + + + +
NameDatatypeDescription
portal_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the portals resource, the following permissions are required: + +### Create +
+workspaces-web:CreatePortal,
+workspaces-web:GetPortal,
+workspaces-web:GetPortalServiceProviderMetadata,
+workspaces-web:AssociateBrowserSettings,
+workspaces-web:AssociateIpAccessSettings,
+workspaces-web:AssociateNetworkSettings,
+workspaces-web:AssociateTrustStore,
+workspaces-web:AssociateUserAccessLoggingSettings,
+workspaces-web:AssociateUserSettings,
+workspaces-web:ListTagsForResource,
+workspaces-web:TagResource,
+kms:CreateGrant,
+kms:GenerateDataKey,
+kms:Decrypt,
+ec2:CreateNetworkInterface,
+ec2:CreateNetworkInterfacePermission,
+ec2:DeleteNetworkInterface,
+ec2:DeleteNetworkInterfacePermission,
+ec2:ModifyNetworkInterfaceAttribute,
+kinesis:PutRecord,
+kinesis:PutRecords,
+kinesis:DescribeStreamSummary,
+sso:CreateManagedApplicationInstance,
+sso:DescribeRegisteredRegions
+ +### List +
+workspaces-web:ListPortals,
+kms:Decrypt
+ + +## Example +```sql +SELECT +region, +portal_arn +FROM awscc.workspacesweb.portals +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md new file mode 100644 index 0000000000..78dcb8a7a5 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md @@ -0,0 +1,80 @@ +--- +title: trust_store +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store + - 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 +--- +Gets an individual trust_store resource + +## Overview + + + + + +
Nametrust_store
TypeResource
Descriptiontrust_store
Idawscc.workspacesweb.trust_store
+ +## Fields + + + + + + + + +
NameDatatypeDescription
associated_portal_arnsarray
certificate_listarray
tagsarray
trust_store_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_store resource, the following permissions are required: + +### Read +
+workspaces-web:GetTrustStore,
+workspaces-web:GetTrustStoreCertificate,
+workspaces-web:ListTagsForResource,
+workspaces-web:ListTrustStoreCertificates
+ +### Update +
+workspaces-web:UpdateTrustStore,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+workspaces-web:GetTrustStore,
+workspaces-web:GetTrustStoreCertificate,
+workspaces-web:ListTagsForResource,
+workspaces-web:ListTrustStoreCertificates
+ +### Delete +
+workspaces-web:GetTrustStore,
+workspaces-web:GetTrustStoreCertificate,
+workspaces-web:DeleteTrustStore
+ + +## Example +```sql +SELECT +region, +associated_portal_arns, +certificate_list, +tags, +trust_store_arn +FROM awscc.workspacesweb.trust_store +WHERE region = 'us-east-1' +AND data__Identifier = '<TrustStoreArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md new file mode 100644 index 0000000000..0a14899f33 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md @@ -0,0 +1,64 @@ +--- +title: trust_stores +hide_title: false +hide_table_of_contents: false +keywords: + - trust_stores + - 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 +--- +Retrieves a list of trust_stores in a region + +## Overview + + + + + +
Nametrust_stores
TypeResource
Descriptiontrust_stores
Idawscc.workspacesweb.trust_stores
+ +## Fields + + + + + +
NameDatatypeDescription
trust_store_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the trust_stores resource, the following permissions are required: + +### Create +
+workspaces-web:CreateTrustStore,
+workspaces-web:GetTrustStore,
+workspaces-web:GetTrustStoreCertificate,
+workspaces-web:ListTrustStoreCertificates,
+workspaces-web:ListTagsForResource,
+workspaces-web:TagResource
+ +### List +
+workspaces-web:ListTrustStores,
+workspaces-web:ListTrustStoreCertificates
+ + +## Example +```sql +SELECT +region, +trust_store_arn +FROM awscc.workspacesweb.trust_stores +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/user_access_logging_settings/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/user_access_logging_settings/index.md new file mode 100644 index 0000000000..291cf037c3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/user_access_logging_settings/index.md @@ -0,0 +1,77 @@ +--- +title: user_access_logging_settings +hide_title: false +hide_table_of_contents: false +keywords: + - user_access_logging_settings + - 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 +--- +Gets an individual user_access_logging_settings resource + +## Overview + + + + + +
Nameuser_access_logging_settings
TypeResource
Descriptionuser_access_logging_settings
Idawscc.workspacesweb.user_access_logging_settings
+ +## Fields + + + + + + + + +
NameDatatypeDescription
associated_portal_arnsarray
kinesis_stream_arnstringKinesis stream ARN to which log events are published.
tagsarray
user_access_logging_settings_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_access_logging_settings resource, the following permissions are required: + +### Read +
+workspaces-web:GetUserAccessLoggingSettings,
+workspaces-web:ListTagsForResource
+ +### Update +
+workspaces-web:UpdateUserAccessLoggingSettings,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+workspaces-web:GetUserAccessLoggingSettings,
+workspaces-web:ListTagsForResource,
+kinesis:PutRecord,
+kinesis:PutRecords
+ +### Delete +
+workspaces-web:GetUserAccessLoggingSettings,
+workspaces-web:DeleteUserAccessLoggingSettings
+ + +## Example +```sql +SELECT +region, +associated_portal_arns, +kinesis_stream_arn, +tags, +user_access_logging_settings_arn +FROM awscc.workspacesweb.user_access_logging_settings +WHERE region = 'us-east-1' +AND data__Identifier = '<UserAccessLoggingSettingsArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md new file mode 100644 index 0000000000..e9a1953b7c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md @@ -0,0 +1,105 @@ +--- +title: user_settings +hide_title: false +hide_table_of_contents: false +keywords: + - user_settings + - 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 +--- +Gets an individual user_settings resource + +## Overview + + + + + +
Nameuser_settings
TypeResource
Descriptionuser_settings
Idawscc.workspacesweb.user_settings
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
associated_portal_arnsarray
cookie_synchronization_configurationobject
copy_allowedstring
customer_managed_keystring
disconnect_timeout_in_minutesnumber
download_allowedstring
idle_disconnect_timeout_in_minutesnumber
paste_allowedstring
print_allowedstring
tagsarray
upload_allowedstring
user_settings_arnstring
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the user_settings resource, the following permissions are required: + +### Read +
+workspaces-web:GetUserSettings,
+workspaces-web:ListTagsForResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ +### Update +
+workspaces-web:UpdateUserSettings,
+workspaces-web:TagResource,
+workspaces-web:UntagResource,
+workspaces-web:GetUserSettings,
+workspaces-web:ListTagsForResource,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ +### Delete +
+workspaces-web:GetUserSettings,
+workspaces-web:DeleteUserSettings,
+kms:CreateGrant,
+kms:DescribeKey,
+kms:GenerateDataKey,
+kms:Decrypt
+ + +## Example +```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 awscc.workspacesweb.user_settings +WHERE region = 'us-east-1' +AND data__Identifier = '<UserSettingsArn>' +``` diff --git a/docs/awscc-docs/providers/awscc/xray/group/index.md b/docs/awscc-docs/providers/awscc/xray/group/index.md new file mode 100644 index 0000000000..589a41005c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/xray/group/index.md @@ -0,0 +1,75 @@ +--- +title: group +hide_title: false +hide_table_of_contents: false +keywords: + - group + - 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 +--- +Gets an individual group resource + +## Overview + + + + + +
Namegroup
TypeResource
Descriptiongroup
Idawscc.xray.group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
filter_expressionstringThe filter expression defining criteria by which to group traces.
group_namestringThe case-sensitive name of the new group. Names must be unique.
group_ar_nstringThe ARN of the group that was generated on creation.
insights_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +
+xray:GetGroup,
+xray:ListTagsForResource
+ +### Update +
+xray:UpdateGroup,
+xray:TagResource,
+xray:UntagResource,
+xray:ListTagsForResource
+ +### Delete +
+xray:DeleteGroup
+ + +## Example +```sql +SELECT +region, +filter_expression, +group_name, +group_ar_n, +insights_configuration, +tags +FROM awscc.xray.group +WHERE region = 'us-east-1' +AND data__Identifier = '<GroupARN>' +``` diff --git a/docs/awscc-docs/providers/awscc/xray/groups/index.md b/docs/awscc-docs/providers/awscc/xray/groups/index.md new file mode 100644 index 0000000000..55759de731 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/xray/groups/index.md @@ -0,0 +1,60 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - groups + - 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 +--- +Retrieves a list of groups in a region + +## Overview + + + + + +
Namegroups
TypeResource
Descriptiongroups
Idawscc.xray.groups
+ +## Fields + + + + + +
NameDatatypeDescription
group_ar_nstringThe ARN of the group that was generated on creation.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +
+xray:CreateGroup,
+xray:TagResource
+ +### List +
+xray:GetGroups,
+xray:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +group_ar_n +FROM awscc.xray.groups +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/xray/index.md b/docs/awscc-docs/providers/awscc/xray/index.md new file mode 100644 index 0000000000..2ea66c07e3 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/xray/index.md @@ -0,0 +1,43 @@ +--- +title: xray +hide_title: false +hide_table_of_contents: false +keywords: + - 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 +--- + +The xray service documentation. + +:::info Service Summary + +
+
+total resources: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+group
+groups
+resource_policies +
+
+resource_policy
+sampling_rule
+sampling_rules +
+
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/xray/resource_policies/index.md b/docs/awscc-docs/providers/awscc/xray/resource_policies/index.md new file mode 100644 index 0000000000..a7b8dedbd0 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/xray/resource_policies/index.md @@ -0,0 +1,59 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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 +--- +Retrieves a list of resource_policies in a region + +## Overview + + + + + +
Nameresource_policies
TypeResource
Descriptionresource_policies
Idawscc.xray.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_namestringThe name of the resource policy. Must be unique within a specific AWS account.
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +
+xray:PutResourcePolicy,
+xray:ListResourcePolicies
+ +### List +
+xray:ListResourcePolicies
+ + +## Example +```sql +SELECT +region, +policy_name +FROM awscc.xray.resource_policies +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/providers/awscc/xray/resource_policy/index.md b/docs/awscc-docs/providers/awscc/xray/resource_policy/index.md new file mode 100644 index 0000000000..93e539e36c --- /dev/null +++ b/docs/awscc-docs/providers/awscc/xray/resource_policy/index.md @@ -0,0 +1,68 @@ +--- +title: resource_policy +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy + - 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 +--- +Gets an individual resource_policy resource + +## Overview + + + + + +
Nameresource_policy
TypeResource
Descriptionresource_policy
Idawscc.xray.resource_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
policy_namestringThe name of the resource policy. Must be unique within a specific AWS account.
policy_documentstringThe resource policy document, which can be up to 5kb in size.
bypass_policy_lockout_checkbooleanA flag to indicate whether to bypass the resource policy lockout safety check
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +
+xray:ListResourcePolicies
+ +### Update +
+xray:PutResourcePolicy,
+xray:ListResourcePolicies
+ +### Delete +
+xray:DeleteResourcePolicy
+ + +## Example +```sql +SELECT +region, +policy_name, +policy_document, +bypass_policy_lockout_check +FROM awscc.xray.resource_policy +WHERE region = 'us-east-1' +AND data__Identifier = '<PolicyName>' +``` diff --git a/docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md b/docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md new file mode 100644 index 0000000000..9425089622 --- /dev/null +++ b/docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md @@ -0,0 +1,77 @@ +--- +title: sampling_rule +hide_title: false +hide_table_of_contents: false +keywords: + - sampling_rule + - 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 +--- +Gets an individual sampling_rule resource + +## Overview + + + + + +
Namesampling_rule
TypeResource
Descriptionsampling_rule
Idawscc.xray.sampling_rule
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
sampling_ruleobject
sampling_rule_recordobject
sampling_rule_updateobject
rule_ar_nstring
rule_namestring
tagsarray
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sampling_rule resource, the following permissions are required: + +### Read +
+xray:GetSamplingRules,
+xray:ListTagsForResource
+ +### Update +
+xray:UpdateSamplingRule,
+xray:TagResource,
+xray:UntagResource,
+xray:ListTagsForResource
+ +### Delete +
+xray:DeleteSamplingRule
+ + +## Example +```sql +SELECT +region, +sampling_rule, +sampling_rule_record, +sampling_rule_update, +rule_ar_n, +rule_name, +tags +FROM awscc.xray.sampling_rule +WHERE region = 'us-east-1' +AND data__Identifier = '<RuleARN>' +``` diff --git a/docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md b/docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md new file mode 100644 index 0000000000..35e0bd297a --- /dev/null +++ b/docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md @@ -0,0 +1,60 @@ +--- +title: sampling_rules +hide_title: false +hide_table_of_contents: false +keywords: + - sampling_rules + - 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 +--- +Retrieves a list of sampling_rules in a region + +## Overview + + + + + +
Namesampling_rules
TypeResource
Descriptionsampling_rules
Idawscc.xray.sampling_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_ar_nundefined
regionstringAWS region.
+ +## Methods +Currently only SELECT is supported for this resource resource. + +## Permissions + +To operate on the sampling_rules resource, the following permissions are required: + +### Create +
+xray:CreateSamplingRule,
+xray:TagResource
+ +### List +
+xray:GetSamplingRules,
+xray:ListTagsForResource
+ + +## Example +```sql +SELECT +region, +rule_ar_n +FROM awscc.xray.sampling_rules +WHERE region = 'us-east-1' +``` diff --git a/docs/awscc-docs/stackql-provider-registry.mdx b/docs/awscc-docs/stackql-provider-registry.mdx new file mode 100644 index 0000000000..2e8227bf17 --- /dev/null +++ b/docs/awscc-docs/stackql-provider-registry.mdx @@ -0,0 +1,20 @@ +--- +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'; + + + +--- + diff --git a/package.json b/package.json index 15d38d8d9d..2285e8be59 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "docusaurus": "docusaurus", "start": "docusaurus start", "start:aws": "export REGISTRY=aws && docusaurus start", + "start:awscc": "export REGISTRY=awscc && docusaurus start", "start:azure": "export REGISTRY=azure && docusaurus start", "start:digitalocean": "export REGISTRY=digitalocean && docusaurus start", "start:linode": "export REGISTRY=linode && docusaurus start", @@ -27,6 +28,7 @@ "start:homebrew": "export REGISTRY=homebrew && docusaurus start", "build:root": "docusaurus build", "build:aws": "export REGISTRY=aws && docusaurus build", + "build:awscc": "export REGISTRY=awscc && docusaurus build", "build:azure": "export REGISTRY=azure && docusaurus build", "build:digitalocean": "export REGISTRY=digitalocean && docusaurus build", "build:linode": "export REGISTRY=linode && docusaurus build", diff --git a/scripts/docgen/provider_data.py b/scripts/docgen/provider_data.py index 35e7e8a02a..3ead539cd8 100644 --- a/scripts/docgen/provider_data.py +++ b/scripts/docgen/provider_data.py @@ -329,6 +329,7 @@ 'variables': """ - `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) - `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) +- `AWS_SESSION_TOKEN` - [__OPTIONAL:__ only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)) """, 'linux': """ AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}' diff --git a/sidebars.js b/sidebars.js index 2e960556cd..6b5b4bc8be 100644 --- a/sidebars.js +++ b/sidebars.js @@ -18,6 +18,7 @@ const providers = [ {name: 'googleadmin'}, {name: 'azure'}, {name: 'aws'}, + {name: 'awscc'}, {name: 'digitalocean'}, {name: 'github'}, {name: 'linode'}, diff --git a/src/configs/providers.ts b/src/configs/providers.ts index dfa8fdf248..93ee080ad8 100644 --- a/src/configs/providers.ts +++ b/src/configs/providers.ts @@ -5,6 +5,7 @@ export const providers = [ {name: 'googleadmin', description: 'Google Workspace identity services.', title: 'Google Admin'}, {name: 'azure', description: 'Cloud computing services offered by Microsoft.', title: 'Microsoft Azure'}, {name: 'aws', description: 'Cloud computing by Amazon Web Services.', title: 'AWS'}, + {name: 'awscc', description: 'Cloud computing by Amazon Web Services.', title: 'AWS Cloud Control'}, {name: 'digitalocean', description: 'Cloud computing services and Infrastructure as a Service (IaaS).', title: 'Digital Ocean'}, {name: 'github', description: 'Web-based version-control and collaboration.', title: 'GitHub'}, {name: 'linode', description: 'Cloud computing services by Akamai.', title: 'Linode'},